docs(sdk): cover the session logout endpoint across docs and all five SDKs - #995
Merged
Conversation
… SDKs POST /sessions/:id/logout is reachable over REST but was absent from the hand-written reference docs and from every SDK, leaving each client one session route behind the API. Adds the route to docs/06 (with the 400 raised for a session that is not running), the curl collection in docs/07, the AuditAction enumeration in docs/05, the deliberate-omission list in docs/24, and the per-language method tables in docs/18 and sdk/README.md. Adds a logout method to the Go, Java, JavaScript, PHP and Python SDKs, mirroring the neighbouring forceKill in each, plus a routing test per language asserting the exact path. The dashboard's sessionApi gains a matching logout(id), and the CHANGELOG records the client-side additions. docs/18 documents only the TypeScript, Python and PHP SDKs; Go and Java have never been covered there, which is left as-is.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Follow-up to #984 (now merged).
POST /sessions/:id/logoutis reachable over REST but was absent from the hand-written reference docs and from every client, leaving each one a session route behind the API. This brings docs, all five SDKs, and the dashboard's API client back in sync.docs/06(including the 400 raised for a session that is not running), curl collection entry indocs/07,session_logged_outadded to theAuditActionenumeration indocs/05, the deliberate-omission list indocs/24, and the per-language method tables indocs/18andsdk/README.md.logoutmethod in the Go, Java, JavaScript, PHP, and Python SDKs, each mirroring the neighbouringforceKill, plus a routing test per language asserting the exact path.sessionApi.logout(id)indashboard/src/services/api.ts.[Unreleased] → Added.No runtime behaviour changes; docs/client surface only.
docs/18documents only the TypeScript, Python, and PHP SDKs — Go and Java have never been covered there, which is left as-is.Type of Change
Checklist
Related Issues
Relates to #984