Document the /logout api

We have one, and it's useful, so we really ought to document it
This commit is contained in:
Richard van der Hoff 2016-05-08 22:26:49 +01:00
parent 2e446594a1
commit e7e9f5fa46
3 changed files with 35 additions and 0 deletions

View 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