Improve authentication documentation #1086
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
This also updates the documentation to reflect the new public access approach, where not all requests need authentication.
This is mainly a convenience -- it's always been a minor pain point, and duplicating the authentication routes here lets the documentation page be interactive and allows users to try them out.
Mr0grog
added a commit
to edgi-govdata-archiving/web-monitoring-ops
that referenced
this pull request
Feb 7, 2023
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.
Now that we have public
viewpermission, this updates the documentation to reflect it by describing how and when to authenticate.It also duplicates the two main authentication routes under the API namespace at
/api/v0/users/sign_inand/api/v0/users/session— the fact that they were at the root has always been confusing and this also allows the interactive features in the docs page to work.