wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Mention that we use OpenAPI 3's response code format

Browse source 
See comments of https://github.com/matrix-org/matrix-doc/pull/2238
This commit is contained in:
Travis Ralston 2020-05-20 18:00:27 -06:00
parent 3875d50de8
commit 1388742a52
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
api/openapi_extensions.md
View file

@ -43,3 +43,11 @@ doesn't work, as in the following example:
properties: properties:
... ...
``` ```
## OpenAPI 3's "2xx" format for response codes
<!-- TODO: Remove this section after upgrading to OpenAPI v3 -->
In some cases, the schema will have HTTP response code definitions like
`2xx`, `3xx`, and `4xx`. These indicate that a response code within those
ranges (`2xx` = `200` to `299`) is valid for the schema.