Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-20 16:38:37 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

c2s: clean up $ref objects

Browse source 
* Most of the changes: align to the $ref object definition
  (https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03#section-3)
  that says that any attribute other than $ref be ignored.
* Remove extraneous leading ./ in $ref paths
* Fix an apparent typo in registration.yaml:
  /account/password/msisdn/requestToken used a file from ../identity/*
  instead of its c2s namesake.
This commit is contained in:
Kitsune Ral 2020-05-25 20:40:00 +02:00
parent c72d30513e
commit 6cfb94562e
6 changed files with 42 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
api/client-server/administrative_contact.yaml
View file

@ -201,10 +201,11 @@ paths:
type: object type: object
properties: properties:
auth: auth:
description: |- allOf:
Additional authentication information for the - description: |-
user-interactive authentication API. Additional authentication information for the
$ref: "definitions/auth_data.yaml" user-interactive authentication API.
- $ref: "definitions/auth_data.yaml"
client_secret: client_secret:
type: string type: string
description: The client secret used in the session with the homeserver. description: The client secret used in the session with the homeserver.
@ -432,7 +433,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: "./definitions/request_email_validation.yaml" $ref: "definitions/request_email_validation.yaml"
responses: responses:
200: 200:
description: |- description: |-
@ -482,7 +483,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: "./definitions/request_msisdn_validation.yaml" $ref: "definitions/request_msisdn_validation.yaml"
responses: responses:
200: 200:
description: An SMS message was sent to the given phone number. description: An SMS message was sent to the given phone number.

12
api/client-server/device_management.yaml
View file

@ -83,7 +83,7 @@ paths:
schema: schema:
type: object type: object
allOf: allOf:
- $ref: "definitions/client_device.yaml" - $ref: "definitions/client_device.yaml"
examples: examples:
application/json: { application/json: {
"device_id": "QBUAZIFURK", "device_id": "QBUAZIFURK",
@ -158,9 +158,10 @@ paths:
properties: properties:
auth: auth:
description: |- description: |-
Additional authentication information for the Additional authentication information for the
user-interactive authentication API. user-interactive authentication API.
"$ref": "definitions/auth_data.yaml" allOf:
- "$ref": "definitions/auth_data.yaml"
responses: responses:
200: 200:
description: |- description: |-
@ -203,10 +204,11 @@ paths:
description: A list of device IDs. description: A list of device IDs.
example: ["QBUAZIFURK", "AUIECTSRND"] example: ["QBUAZIFURK", "AUIECTSRND"]
auth: auth:
allOf:
- "$ref": "definitions/auth_data.yaml"
description: |- description: |-
Additional authentication information for the Additional authentication information for the
user-interactive authentication API. user-interactive authentication API.
"$ref": "definitions/auth_data.yaml"
required: required:
- devices - devices
responses: responses:

16
api/client-server/login.yaml
View file

@ -100,7 +100,6 @@ paths:
enum: ["m.login.password", "m.login.token"] enum: ["m.login.password", "m.login.token"]
description: The login type being used. description: The login type being used.
identifier: identifier:
description: Identification information for the user.
"$ref": "definitions/user_identifier.yaml" "$ref": "definitions/user_identifier.yaml"
user: user:
type: string type: string
@ -176,13 +175,14 @@ paths:
ID of the logged-in device. Will be the same as the ID of the logged-in device. Will be the same as the
corresponding parameter in the request, if one was specified. corresponding parameter in the request, if one was specified.
well_known: well_known:
type: object allOf:
description: |- - type: object
Optional client configuration provided by the server. If present, description: |-
clients SHOULD use the provided object to reconfigure themselves, Optional client configuration provided by the server. If present,
optionally validating the URLs within. This object takes the same clients SHOULD use the provided object to reconfigure themselves,
form as the one returned from .well-known autodiscovery. optionally validating the URLs within. This object takes the same
"$ref": "definitions/wellknown/full.yaml" form as the one returned from .well-known autodiscovery.
- "$ref": "definitions/wellknown/full.yaml"
400: 400:
description: |- description: |-
Part of the request was invalid. For example, the login type may not be recognised. Part of the request was invalid. For example, the login type may not be recognised.

33
api/client-server/registration.yaml
View file

@ -89,13 +89,14 @@ paths:
type: object type: object
properties: properties:
auth: auth:
description: |- allOf:
Additional authentication information for the - description: |-
user-interactive authentication API. Note that this Additional authentication information for the
information is *not* used to define how the registered user user-interactive authentication API. Note that this
should be authenticated, but is instead used to information is *not* used to define how the registered user
authenticate the ``register`` call itself. should be authenticated, but is instead used to
"$ref": "definitions/auth_data.yaml" authenticate the ``register`` call itself.
- "$ref": "definitions/auth_data.yaml"
username: username:
type: string type: string
description: |- description: |-
@ -228,7 +229,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: "./definitions/request_email_validation.yaml" $ref: "definitions/request_email_validation.yaml"
responses: responses:
200: 200:
description: |- description: |-
@ -278,7 +279,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: "./definitions/request_msisdn_validation.yaml" $ref: "definitions/request_msisdn_validation.yaml"
responses: responses:
200: 200:
description: |- description: |-
@ -346,9 +347,10 @@ paths:
description: The new password for the account. description: The new password for the account.
example: "ihatebananas" example: "ihatebananas"
auth: auth:
description: |- allOf:
Additional authentication information for the user-interactive authentication API. - description: |-
"$ref": "definitions/auth_data.yaml" Additional authentication information for the user-interactive authentication API.
- "$ref": "definitions/auth_data.yaml"
required: ["new_password"] required: ["new_password"]
responses: responses:
200: 200:
@ -397,7 +399,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: "./definitions/request_email_validation.yaml" $ref: "definitions/request_email_validation.yaml"
responses: responses:
200: 200:
description: An email was sent to the given address. description: An email was sent to the given address.
@ -455,7 +457,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: "../identity/definitions/request_msisdn_validation.yaml" $ref: "definitions/request_msisdn_validation.yaml"
responses: responses:
200: 200:
description: An SMS message was sent to the given phone number. description: An SMS message was sent to the given phone number.
@ -516,7 +518,8 @@ paths:
auth: auth:
description: |- description: |-
Additional authentication information for the user-interactive authentication API. Additional authentication information for the user-interactive authentication API.
"$ref": "definitions/auth_data.yaml" allOf:
- $ref: "definitions/auth_data.yaml"
id_server: id_server:
type: string type: string
description: |- description: |-

3
api/client-server/search.yaml
View file

@ -96,7 +96,8 @@ paths:
# for now :/ # for now :/
description: |- description: |-
This takes a `filter`_. This takes a `filter`_.
$ref: "definitions/room_event_filter.yaml" allOf:
- $ref: "definitions/room_event_filter.yaml"
order_by: order_by:
title: "Ordering" title: "Ordering"
type: string type: string

1
api/client-server/wellknown.yaml
View file

@ -39,7 +39,6 @@ paths:
200: 200:
description: Server discovery information. description: Server discovery information.
schema: schema:
type: object
"$ref": "definitions/wellknown/full.yaml" "$ref": "definitions/wellknown/full.yaml"
404: 404:
description: No server discovery information available. description: No server discovery information available.