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

2
data/api/client-server/banning.yaml
View file

@ -60,6 +60,7 @@ paths:
type: string
description: The fully qualified user ID of the user being banned.
reason:
x-addedInMatrixVersion: "1.1"
type: string
description: The reason the user has been banned. This will be supplied as the
`reason` on the target's updated [`m.room.member`](/client-server-api/#mroommember) event.
@ -119,6 +120,7 @@ paths:
type: string
description: The fully qualified user ID of the user being unbanned.
reason:
x-addedInMatrixVersion: "1.1"
type: string
description: |-
Optional reason to be included as the `reason` on the subsequent

2
data/api/client-server/cross_signing.yaml
View file

@ -29,6 +29,7 @@ securityDefinitions:
paths:
"/keys/device_signing/upload":
post:
x-addedInMatrixVersion: "1.1"
summary: Upload cross-signing keys.
description: |-
Publishes cross-signing keys for the user.
@ -140,6 +141,7 @@ paths:
- End-to-end encryption
"/keys/signatures/upload":
post:
x-addedInMatrixVersion: "1.1"
summary: Upload cross-signing signatures.
description: |-
Publishes cross-signing signatures for the user. The request body is a

1
data/api/client-server/inviting.yaml
View file

@ -72,6 +72,7 @@ paths:
type: string
description: The fully qualified user ID of the invitee.
reason:
x-addedInMatrixVersion: "1.1"
type: string
description: |-
Optional reason to be included as the `reason` on the subsequent

2
data/api/client-server/joining.yaml
View file

@ -66,6 +66,7 @@ paths:
`m.room.third_party_invite` event in the room, and perform
key validity checking if required by the event.
reason:
x-addedInMatrixVersion: "1.1"
type: string
description: |-
Optional reason to be included as the `reason` on the subsequent
@ -152,6 +153,7 @@ paths:
that it matches a pending `m.room.third_party_invite` event in the
room, and perform key validity checking if required by the event.
reason:
x-addedInMatrixVersion: "1.1"
type: string
description: |-
Optional reason to be included as the `reason` on the subsequent

3
data/api/client-server/key_backup.yaml
View file

@ -29,6 +29,7 @@ securityDefinitions:
paths:
"/room_keys/version":
post:
x-addedInMatrixVersion: "1.1"
summary: Create a new backup.
description: |-
Creates a new backup.
@ -157,6 +158,7 @@ paths:
- End-to-end encryption
"/room_keys/version/{version}":
get:
x-addedInMatrixVersion: "1.1"
summary: Get information about an existing backup.
description: |-
Get information about an existing backup.
@ -734,6 +736,7 @@ paths:
- End-to-end encryption
"/room_keys/keys":
put:
x-addedInMatrixVersion: "1.1"
summary: Store several keys in the backup.
description: |-
Store several keys in the backup.

2
data/api/client-server/keys.yaml
View file

@ -238,6 +238,7 @@ paths:
}
}
master_keys:
x-addedInMatrixVersion: "1.1"
type: object
description: |-
Information on the master cross-signing keys of the queried users.
@ -259,6 +260,7 @@ paths:
}
}
self_signing_keys:
x-addedInMatrixVersion: "1.1"
type: object
description: |-
Information on the self-signing keys of the queried users. A map

1
data/api/client-server/knocking.yaml
View file

@ -29,6 +29,7 @@ securityDefinitions:
paths:
"/knock/{roomIdOrAlias}":
post:
x-addedInMatrixVersion: "1.1"
summary: Knock on a room, requesting permission to join.
description: |-
*Note that this API takes either a room ID or alias, unlike other membership APIs.*

1
data/api/client-server/leaving.yaml
View file

@ -62,6 +62,7 @@ paths:
}
properties:
reason:
x-addedInMatrixVersion: "1.1"
type: string
description: |-
Optional reason to be included as the `reason` on the subsequent

2
data/api/client-server/sso_login_redirect.yaml
View file

@ -23,6 +23,7 @@ basePath: /_matrix/client/v3
paths:
"/login/sso/redirect":
get:
x-addedInMatrixVersion: "1.1"
summary: Redirect the user's browser to the SSO interface.
description: |-
A web-based Matrix client should instruct the user's browser to
@ -50,6 +51,7 @@ paths:
- Session management
"/login/sso/redirect/{idpId}":
get:
x-addedInMatrixVersion: "1.1"
summary: Redirect the user's browser to the SSO interface for an IdP.
description: |-
This endpoint is the same as `/login/sso/redirect`, though with an

1
data/api/client-server/whoami.yaml
View file

@ -58,6 +58,7 @@ paths:
type: string
description: The user ID that owns the access token.
device_id:
x-addedInMatrixVersion: "1.1"
type: string
description: |-
Device ID associated with the access token. If no device

1
data/api/identity/versions.yaml
View file

@ -24,6 +24,7 @@ produces:
paths:
"/versions":
get:
x-addedInMatrixVersion: "1.1"
summary: Gets the versions of the specification supported by the server.
description: |-
Gets the versions of the specification supported by the server.

1
data/api/server-server/definitions/event-schemas/m.device_list_update.yaml
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: |-

1
data/api/server-server/definitions/event-schemas/m.signing_key_update.yaml
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: |-

2
data/api/server-server/knocks.yaml
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

2
data/api/server-server/user_keys.yaml
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

1
data/event-schemas/schema/m.room.member.yaml
View file

@ -64,6 +64,7 @@ properties:
description: Flag indicating if the room containing this event was created with the intention of being a direct chat. See [Direct Messaging](/client-server-api/#direct-messaging).
type: boolean
reason:
x-addedInMatrixVersion: "1.1"
type: string
description: |-
Optional user-supplied text for why their membership has changed. For kicks and bans, this is typically the reason for the kick or ban.