[Issue #3240] Write docs for API authentication logic #3329
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
chouinar
requested review from
acouch,
andycochran,
btabaska,
coilysiren,
doug-s-nava,
mdragon and
widal001
as code owners
doug-s-nava
approved these changes
Dec 20, 2024
| ## Logout | ||
| The logout endpoint will log out the session associated with the passed-in token. | ||
|
|
||
| It does this by setting the `is_valid` boolean to False. |
There was a problem hiding this comment.
not directly related, but curious if there's been a decision about how often to clean out session related tables
There was a problem hiding this comment.
Haven't had a discussion, I'd argue that it would be good to keep sessions for at least a few weeks for debugging purposes. Unless we're getting into the tens of millions, I wouldn't see much concern for performance.
Maybe something like 6 months? When we launch this, we'll get a better idea of how many sessions we're maintaining and go from there probably
mdragon
approved these changes
Dec 20, 2024
doug-s-nava
pushed a commit
that referenced
this pull request
Dec 30, 2024
## Summary Fixes #3240 ### Time to review: __10 mins__ ## Changes proposed Added documentation for the authentication logic ## Context for reviewers Hopefully covered most of the useful auth details, please let me know if anything isn't clear or should have more detail
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.
Summary
Fixes #3240
Time to review: 10 mins
Changes proposed
Added documentation for the authentication logic
Context for reviewers
Hopefully covered most of the useful auth details, please let me know if anything isn't clear or should have more detail