Add method Wikimate::logout() #124
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
Open
waldyrious
reviewed
Aug 25, 2021
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.
Covers the API action Logout and discards CSRF token (per #115).
The error code value is 'auth' because it doesn't make much sense to define a code 'logout' that's unlikely ever checked. Instead it would be logical to change the 'login' code into 'auth' as well (possibly also useful for #87 and #89), but that would be an small API-breaking change (similar to #116), so has to be delayed til v1.0.0. Hence the 'auth' entry is added to USAGE.md but the 'login' entry not yet removed.
A logout() example in USAGE.md would be too trivial so I didn't bother.
USAGE.md also includes a user agent fix I missed in #121.