From e7e9f5fa46232bf77df259b852372ebff7d6a02c Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Sun, 8 May 2016 22:26:49 +0100 Subject: [PATCH] Document the /logout api We have one, and it's useful, so we really ought to document it --- api/client-server/logout.yaml | 32 +++++++++++++++++++++++++++++ changelogs/client_server.rst | 1 + specification/client_server_api.rst | 2 ++ 3 files changed, 35 insertions(+) create mode 100644 api/client-server/logout.yaml diff --git a/api/client-server/logout.yaml b/api/client-server/logout.yaml new file mode 100644 index 00000000..dc587b60 --- /dev/null +++ b/api/client-server/logout.yaml @@ -0,0 +1,32 @@ +swagger: '2.0' +info: + title: "Matrix Client-Server Registration and Login API" + version: "1.0.0" +host: localhost:8008 +schemes: + - https + - http +basePath: /_matrix/client/%CLIENT_MAJOR_VERSION% +consumes: + - application/json +produces: + - application/json +securityDefinitions: + $ref: definitions/security.yaml +paths: + "/logout": + post: + summary: Invalidates a user access token + description: |- + Invalidates an existing access token, so that it can no longer be used for + authorization. + security: + - accessToken: [] + responses: + 200: + description: The access token used in the request was succesfully invalidated. + schema: + type: object + properties: [] + tags: + - Session management diff --git a/changelogs/client_server.rst b/changelogs/client_server.rst index a5b8d1f9..667b9f67 100644 --- a/changelogs/client_server.rst +++ b/changelogs/client_server.rst @@ -24,6 +24,7 @@ This release includes the following changes since r0.0.1: - New endpoints: + - ``POST /logout`` - ``POST /rooms/{roomId}/unban`` - ``POST /rooms/{roomId}/kick`` - ``GET /pushers`` diff --git a/specification/client_server_api.rst b/specification/client_server_api.rst index af608ff4..a63ddbef 100644 --- a/specification/client_server_api.rst +++ b/specification/client_server_api.rst @@ -528,6 +528,8 @@ homeserver must respond with 403 Forbidden. {{login_cs_http_api}} +{{logout_cs_http_api}} + Login Fallback <<<<<<<<<<<<<<