Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-04-13 06:34:10 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #2561 from matrix-org/travis/doc-2xx-format

Browse source 
Mention that we use OpenAPI 3's response code format
This commit is contained in:
Travis Ralston 2020-05-21 07:46:51 -06:00 committed by GitHub
parent ab62b6293c 1388742a52
commit 12ecf9f383
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Show stats 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.