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

* 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

View file

@ -13,6 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
x-addedInMatrixVersion: "1.1"
type: object
title: m.device_list_update
description: |-

View file

@ -12,6 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
x-addedInMatrixVersion: "1.1"
type: object
title: m.signing_key_update
description: |-

View file

@ -29,6 +29,7 @@ securityDefinitions:
paths:
"/make_knock/{roomId}/{userId}":
get:
x-addedInMatrixVersion: "1.1"
summary: Get information required to make a knock event for a room.
description: |-
Asks the receiving server to return information that the sending
@ -190,6 +191,7 @@ paths:
"/send_knock/{roomId}/{eventId}":
put:
x-addedInMatrixVersion: "1.1"
summary: Submit a signed knock event to a resident server.
description: |-
Submits a signed knock event to the resident server for it to

View file

@ -178,6 +178,7 @@ paths:
description:
The display name which the user set on the device.
master_keys:
x-addedInMatrixVersion: "1.1"
type: object
description: |-
Information on the master cross-signing keys of the queried users.
@ -199,6 +200,7 @@ paths:
}
}
self_signing_keys:
x-addedInMatrixVersion: "1.1"
type: object
description: |-
Information on the self-signing keys of the queried users. A map