Document the trusted port for callbacks and docs #52
Conversation
docs/adrs/0002-public-endpoints.md
Outdated
| | Port | Use | Security | Path | | ||
| |-|-|-|-| | ||
| | 8080 | Messaging API | IP Filtering & BasicAuth shared password | https://app-54372.on-aptible.com | | ||
| | [8086](/src/main/resources/application.properties) | Messaging Provider Callbacks & API Documentation | Public w/ Provider Signature varification | https://staging.messaging.cfa-platforms.org/public | |
There was a problem hiding this comment.
@vrajmohan I added this table to make the info easier to see at a glance. I know it is subject to change, especially the port, but it seems unlikely to me that it will.
There was a problem hiding this comment.
IMO, the ADR does not need implementation details like a README or INSTALLING. I expect the engineers to read the code to get those details. I would rather focus the ADR on pros and cons of the decisions made.
There was a problem hiding this comment.
I added the table to make it easier to visually process the information, that there are two ports with different security measures and different urls. The actual ports and urls are not relevant, but I think seeing them broken down in a table helps it click. I agree that this should not be the "source" for this info, and maybe it is risky to have it shown here, but I think it helps clarify the impact of this ADR.
There was a problem hiding this comment.
Updated the table to remove implementation details
No description provided.