PB-1282: document the new authentication method. #504
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adk-swisstopo
commented
Jan 27, 2025
|
This only updates v1, which should probably not refer to the old authentication mechanism. It does not update v0.9 which should probably refer to the new authentication mechanism on top of the old one. However our Makefile is not made to update v0.9 and there has been some drift. Moving this PR to draft until we sort this out. |
As per discussion, we only need to update v1 documentation. |
boecklic
approved these changes
Jan 28, 2025
This also improves the existing documentation: * explain what session authentication is for; * point to relevant RFC for Basic authentication; * be more explicit about the old Token authentication; * add link from /get-token description to the Authentication section.
The [GitGuardian Bearer token detector](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/detectors/generics/bearer_token) does not like it when we add a realistic-looking token. The documentation shows a few ways to make it ignore that token. In this change we use the dummy "123456" value. The previous token was a more realistic dummy but a dummy nonetheless. It has never been a valid token and could not be used to access anything.
This also removes documentation for the /get-token endpoint as it is only relevant for the old Token authentication method. The old authentication methods (Basic and Token) are only supported for v0.9. We do not update the v0.9 spec via the Makefile any more.
adk-swisstopo
force-pushed
the
feat-PB-1282-authdoc
branch
from
73e98b8 to
e2924a9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This also:
This only updates v1 documentation. v0.9 remains unchanged.