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

Fix links in data

Browse source
This commit is contained in:
Will 2021-01-28 16:00:39 -08:00 • committed by Richard van der Hoff
parent 27f8867aa0
commit 873e8b30eb
84 changed files with 211 additions and 220 deletions
Download patch file Download diff file Expand all files Collapse all files

2
data/api/identity/associations.yaml
View file

@ -258,7 +258,7 @@ paths:
medium:
type: string
description: |-
A medium from the `3PID Types`_ Appendix, matching the medium
A medium from the [3PID Types](/appendices/#3pid-types) Appendix, matching the medium
of the identifier to unbind.
address:
type: string

2
data/api/identity/invitation_signing.yaml
View file

@ -53,7 +53,7 @@ paths:
description: The token from the call to `store-invite`.
private_key:
type: string
description: The private key, encoded as `Unpadded base64`_.
description: The private key, encoded as [Unpadded base64](/appendices/#unpadded-base64).
required: ["mxid", "token", "private_key"]
responses:
200:

10
data/api/identity/lookup.yaml
View file

@ -38,13 +38,13 @@ paths:
type: string
name: medium
required: true
description: The medium type of the 3pid. See the `3PID Types`_ Appendix.
description: The medium type of the 3pid. See the [3PID Types](/appendices/#3pid-types) Appendix.
x-example: "email"
- in: query
type: string
name: address
required: true
description: The address of the 3pid being looked up. See the `3PID Types`_ Appendix.
description: The address of the 3pid being looked up. See the [3PID Types](/appendices/#3pid-types) Appendix.
x-example: "louise@bobs.burgers"
responses:
200:
@ -72,7 +72,7 @@ paths:
description: The 3pid address of the user being looked up, matching the address requested.
medium:
type: string
description: A medium from the `3PID Types`_ Appendix, matching the medium requested.
description: A medium from the [3PID Types](/appendices/#3pid-types) Appendix, matching the medium requested.
mxid:
type: string
description: The Matrix user ID associated with the 3pid.
@ -131,7 +131,7 @@ paths:
- type: string
- type: string
description: |-
An array of arrays containing the `3PID Types`_ with the `medium`
An array of arrays containing the [3PID Types](/appendices/#3pid-types) with the `medium`
in first position and the `address` in second position.
required:
- "threepids"
@ -164,7 +164,7 @@ paths:
- type: string
- type: string
description: |-
An array of array containing the `3PID Types`_ with the `medium`
An array of array containing the [3PID Types](/appendices/#3pid-types) with the `medium`
in first position, the `address` in second position and Matrix user
ID in third position.
required:

8
data/api/identity/v2_associations.yaml
View file

@ -98,7 +98,7 @@ paths:
403:
description: |
The user must do something in order to use this endpoint. One example
is an `M_TERMS_NOT_SIGNED` error where the user must `agree to more terms`_.
is an `M_TERMS_NOT_SIGNED` error where the user must [agree to more terms](/identity-service-api/#terms-of-service).
examples:
application/json: {
"errcode": "M_TERMS_NOT_SIGNED",
@ -222,7 +222,7 @@ paths:
403:
description: |
The user must do something in order to use this endpoint. One example
is an `M_TERMS_NOT_SIGNED` error where the user must `agree to more terms`_.
is an `M_TERMS_NOT_SIGNED` error where the user must [agree to more terms](/identity-service-api/#terms-of-service).
examples:
application/json: {
"errcode": "M_TERMS_NOT_SIGNED",
@ -286,7 +286,7 @@ paths:
medium:
type: string
description: |-
A medium from the `3PID Types`_ Appendix, matching the medium
A medium from the [3PID Types](/appendices/#3pid-types) Appendix, matching the medium
of the identifier to unbind.
address:
type: string
@ -318,7 +318,7 @@ paths:
unbinding identifiers).
Another common error code is `M_TERMS_NOT_SIGNED` where the user
needs to `agree to more terms`_ in order to continue.
needs to [agree to more terms](/identity-service-api/#terms-of-service) in order to continue.
examples:
application/json: {
"errcode": "M_FORBIDDEN",

4
data/api/identity/v2_auth.yaml
View file

@ -83,7 +83,7 @@ paths:
403:
description: |
The user must do something in order to use this endpoint. One example
is an `M_TERMS_NOT_SIGNED` error where the user must `agree to more terms`_.
is an `M_TERMS_NOT_SIGNED` error where the user must [agree to more terms](/identity-service-api/#terms-of-service).
examples:
application/json: {
"errcode": "M_TERMS_NOT_SIGNED",
@ -121,7 +121,7 @@ paths:
403:
description: |
The user must do something in order to use this endpoint. One example
is an `M_TERMS_NOT_SIGNED` error where the user must `agree to more terms`_.
is an `M_TERMS_NOT_SIGNED` error where the user must [agree to more terms](/identity-service-api/#terms-of-service).
examples:
application/json: {
"errcode": "M_TERMS_NOT_SIGNED",

6
data/api/identity/v2_email_associations.yaml
View file

@ -77,7 +77,7 @@ paths:
403:
description: |
The user must do something in order to use this endpoint. One example
is an `M_TERMS_NOT_SIGNED` error where the user must `agree to more terms`_.
is an `M_TERMS_NOT_SIGNED` error where the user must [agree to more terms](/identity-service-api/#terms-of-service).
examples:
application/json: {
"errcode": "M_TERMS_NOT_SIGNED",
@ -149,7 +149,7 @@ paths:
403:
description: |
The user must do something in order to use this endpoint. One example
is an `M_TERMS_NOT_SIGNED` error where the user must `agree to more terms`_.
is an `M_TERMS_NOT_SIGNED` error where the user must [agree to more terms](/identity-service-api/#terms-of-service).
examples:
application/json: {
"errcode": "M_TERMS_NOT_SIGNED",
@ -206,7 +206,7 @@ paths:
403:
description: |
The user must do something in order to use this endpoint. One example
is an `M_TERMS_NOT_SIGNED` error where the user must `agree to more terms`_.
is an `M_TERMS_NOT_SIGNED` error where the user must [agree to more terms](/identity-service-api/#terms-of-service).
examples:
application/json: {
"errcode": "M_TERMS_NOT_SIGNED",

4
data/api/identity/v2_invitation_signing.yaml
View file

@ -57,7 +57,7 @@ paths:
description: The token from the call to `store-invite`.
private_key:
type: string
description: The private key, encoded as `Unpadded base64`_.
description: The private key, encoded as [Unpadded base64](/appendices/#unpadded-base64).
required: ["mxid", "token", "private_key"]
responses:
200:
@ -102,7 +102,7 @@ paths:
403:
description: |
The user must do something in order to use this endpoint. One example
is an `M_TERMS_NOT_SIGNED` error where the user must `agree to more terms`_.
is an `M_TERMS_NOT_SIGNED` error where the user must [agree to more terms](/identity-service-api/#terms-of-service).
examples:
application/json: {
"errcode": "M_TERMS_NOT_SIGNED",

6
data/api/identity/v2_phone_associations.yaml
View file

@ -79,7 +79,7 @@ paths:
403:
description: |
The user must do something in order to use this endpoint. One example
is an `M_TERMS_NOT_SIGNED` error where the user must `agree to more terms`_.
is an `M_TERMS_NOT_SIGNED` error where the user must [agree to more terms](/identity-service-api/#terms-of-service).
examples:
application/json: {
"errcode": "M_TERMS_NOT_SIGNED",
@ -151,7 +151,7 @@ paths:
403:
description: |
The user must do something in order to use this endpoint. One example
is an `M_TERMS_NOT_SIGNED` error where the user must `agree to more terms`_.
is an `M_TERMS_NOT_SIGNED` error where the user must [agree to more terms](/identity-service-api/#terms-of-service).
examples:
application/json: {
"errcode": "M_TERMS_NOT_SIGNED",
@ -208,7 +208,7 @@ paths:
403:
description: |
The user must do something in order to use this endpoint. One example
is an `M_TERMS_NOT_SIGNED` error where the user must `agree to more terms`_.
is an `M_TERMS_NOT_SIGNED` error where the user must [agree to more terms](/identity-service-api/#terms-of-service).
examples:
application/json: {
"errcode": "M_TERMS_NOT_SIGNED",

2
data/api/identity/v2_store_invite.yaml
View file

@ -166,7 +166,7 @@ paths:
403:
description: |
The user must do something in order to use this endpoint. One example
is an `M_TERMS_NOT_SIGNED` error where the user must `agree to more terms`_.
is an `M_TERMS_NOT_SIGNED` error where the user must [agree to more terms](/identity-service-api/#terms-of-service).
examples:
application/json: {
"errcode": "M_TERMS_NOT_SIGNED",