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

Add a hyphen between third and party when used as an adjective (#1447)

Browse source
This commit is contained in:
Andrew Morgan 2023-03-08 09:58:29 +00:00 • committed by GitHub
parent 9ebcf5f257
commit c0955a6aee
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
37 changed files with 190 additions and 187 deletions
Download patch file Download diff file Expand all files Collapse all files

4
data/api/application-service/definitions/location.yaml
View file

@ -17,11 +17,11 @@ properties:
type: string
example: "#freenode_#matrix:matrix.org"
protocol:
description: The protocol ID that the third party location is a part of.
description: The protocol ID that the third-party location is a part of.
type: string
example: "irc"
fields:
description: Information used to identify this third party location.
description: Information used to identify this third-party location.
type: object
example: {
"network": "freenode",

2
data/api/application-service/definitions/location_batch.yaml
View file

@ -12,6 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
type: array
description: List of matched third party locations.
description: List of matched third-party locations.
items:
$ref: location.yaml

10
data/api/application-service/definitions/protocol.yaml
View file

@ -16,28 +16,28 @@ type: object
properties:
user_fields:
description: |-
Fields which may be used to identify a third party user. These should be
Fields which may be used to identify a third-party user. These should be
ordered to suggest the way that entities may be grouped, where higher
groupings are ordered first. For example, the name of a network should be
searched before the nickname of a user.
type: array
items:
type: string
description: Field used to identify a third party user.
description: Field used to identify a third-party user.
example: ["network", "nickname"]
location_fields:
description: |-
Fields which may be used to identify a third party location. These should be
Fields which may be used to identify a third-party location. These should be
ordered to suggest the way that entities may be grouped, where higher
groupings are ordered first. For example, the name of a network should be
searched before the name of a channel.
type: array
items:
type: string
description: Field used to identify a third party location.
description: Field used to identify a third-party location.
example: ["network", "channel"]
icon:
description: A content URI representing an icon for the third party protocol.
description: A content URI representing an icon for the third-party protocol.
type: string
example: "mxc://example.org/aBcDeFgH"
field_types:

2
data/api/application-service/definitions/protocol_metadata.yaml
View file

@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
type: object
description: Dictionary of supported third party protocols.
description: Dictionary of supported third-party protocols.
additionalProperties:
$ref: protocol.yaml
example: {

6
data/api/application-service/definitions/user.yaml
View file

@ -15,15 +15,15 @@
# TODO: Change userid to user_id as a breaking change
properties:
userid:
description: A Matrix User ID represting a third party user.
description: A Matrix User ID represting a third-party user.
type: string
example: "@_gitter_jim:matrix.org"
protocol:
description: The protocol ID that the third party location is a part of.
description: The protocol ID that the third-party location is a part of.
type: string
example: "gitter"
fields:
description: Information used to identify this third party location.
description: Information used to identify this third-party location.
type: object
example: {
"user": "jim"

2
data/api/application-service/definitions/user_batch.yaml
View file

@ -12,6 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
type: array
description: List of matched third party users.
description: List of matched third-party users.
items:
$ref: user.yaml

24
data/api/application-service/protocols.yaml
View file

@ -32,7 +32,7 @@ paths:
summary: Retrieve metadata about a specific protocol that the application service supports.
description: |-
This API is called by the homeserver when it wants to present clients
with specific information about the various third party networks that
with specific information about the various third-party networks that
an application service supports.
operationId: getProtocolMetadata
security:
@ -78,10 +78,10 @@ paths:
$ref: ../client-server/definitions/errors/error.yaml
"/thirdparty/user/{protocol}":
get:
summary: Retrieve the Matrix User ID of a corresponding third party user.
summary: Retrieve the Matrix User ID of a corresponding third-party user.
description: |-
This API is called by the homeserver in order to retrieve a Matrix
User ID linked to a user on the third party network, given a set of
User ID linked to a user on the third-party network, given a set of
user parameters.
operationId: queryUserByProtocol
security:
@ -133,9 +133,9 @@ paths:
$ref: ../client-server/definitions/errors/error.yaml
"/thirdparty/location/{protocol}":
get:
summary: Retrieve Matrix-side portal rooms leading to a third party location.
summary: Retrieve Matrix-side portal rooms leading to a third-party location.
description: |-
Retrieve a list of Matrix portal rooms that lead to the matched third party location.
Retrieve a list of Matrix portal rooms that lead to the matched third-party location.
operationId: queryLocationByProtocol
security:
- homeserverAccessToken: []
@ -151,7 +151,7 @@ paths:
type: string
description: |-
One or more custom fields that are passed to the application
service to help identify the third party location.
service to help identify the third-party location.
responses:
200:
description: At least one portal room was found.
@ -186,9 +186,9 @@ paths:
$ref: ../client-server/definitions/errors/error.yaml
"/thirdparty/location":
get:
summary: Reverse-lookup third party locations given a Matrix room alias.
summary: Reverse-lookup third-party locations given a Matrix room alias.
description: |-
Retrieve an array of third party network locations from a Matrix room
Retrieve an array of third-party network locations from a Matrix room
alias.
operationId: queryLocationByAlias
security:
@ -201,7 +201,7 @@ paths:
responses:
200:
description: |-
All found third party locations.
All found third-party locations.
schema:
$ref: definitions/location_batch.yaml
401:
@ -233,9 +233,9 @@ paths:
$ref: ../client-server/definitions/errors/error.yaml
"/thirdparty/user":
get:
summary: Reverse-lookup third party users given a Matrix User ID.
summary: Reverse-lookup third-party users given a Matrix User ID.
description: |-
Retrieve an array of third party users from a Matrix User ID.
Retrieve an array of third-party users from a Matrix User ID.
operationId: queryUserByID
security:
- homeserverAccessToken: []
@ -247,7 +247,7 @@ paths:
responses:
200:
description: |-
An array of third party users.
An array of third-party users.
schema:
$ref: definitions/user_batch.yaml
401: