Document the /logout api
We have one, and it's useful, so we really ought to document it
This commit is contained in:
parent
2e446594a1
commit
e7e9f5fa46
3 changed files with 35 additions and 0 deletions
32
api/client-server/logout.yaml
Normal file
32
api/client-server/logout.yaml
Normal file
|
@ -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
|
|
@ -24,6 +24,7 @@ This release includes the following changes since r0.0.1:
|
||||||
|
|
||||||
- New endpoints:
|
- New endpoints:
|
||||||
|
|
||||||
|
- ``POST /logout``
|
||||||
- ``POST /rooms/{roomId}/unban``
|
- ``POST /rooms/{roomId}/unban``
|
||||||
- ``POST /rooms/{roomId}/kick``
|
- ``POST /rooms/{roomId}/kick``
|
||||||
- ``GET /pushers``
|
- ``GET /pushers``
|
||||||
|
|
|
@ -528,6 +528,8 @@ homeserver must respond with 403 Forbidden.
|
||||||
|
|
||||||
{{login_cs_http_api}}
|
{{login_cs_http_api}}
|
||||||
|
|
||||||
|
{{logout_cs_http_api}}
|
||||||
|
|
||||||
Login Fallback
|
Login Fallback
|
||||||
<<<<<<<<<<<<<<
|
<<<<<<<<<<<<<<
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue