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

Start annotating which version of the spec added a thing (#3425)

Browse source 
* Introduce a new "added-in" template and use it on endpoints

* Use "added-in" on schema properties too

* Annotate sections of the spec with their added versions

* Demo of "added-in" on a room version (to be fleshed out)

* Use clearer versioning semantics

* Update and fix validator for Swagger custom properties

* Fix docs
This commit is contained in:
Travis Ralston 2021-10-14 13:23:04 -06:00 • committed by GitHub
parent 649fc2bdd2
commit 5be0df02c5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
32 changed files with 380 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

6
openapi_extensions.md
View file

@ -62,3 +62,9 @@ doesn't work, as in the following example:
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.
## Custom `x-addedInMatrixVersion` key
This property is added throughout the OpenAPI schemas to denote which version
of the Matrix specification added the associated object (endpoint, parameter,
property, etc).