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

OpenAPI: use uri format

Browse source 
In avatar_url, pusher url, wellknown base_url, getUrlPreview, and submit_url.

Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
This commit is contained in:
Lukas Lihotzki 2021-08-09 08:54:34 +02:00 • committed by Richard van der Hoff
parent cdcc24af11
commit 91b232df48
12 changed files with 18 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -154,6 +154,7 @@ paths:
properties:
submit_url:
type: string
format: uri
description: |-
An optional field containing a URL where the client must
submit the validation token to, with identical parameters

3
data/api/client-server/content-repo.yaml
View file

@ -66,6 +66,7 @@ paths:
properties:
content_uri:
type: string
format: uri
description: "The [MXC URI](/client-server-api/#matrix-content-mxc-uris) to the uploaded content."
examples:
application/json: {
@ -360,6 +361,7 @@ paths:
parameters:
- in: query
type: string
format: uri
x-example: "https://matrix.org"
name: url
description: "The URL to get a preview of."
@ -389,6 +391,7 @@ paths:
The byte-size of the image. Omitted if there is no image attached.
"og:image":
type: string
format: uri
description: |-
An [MXC URI](/client-server-api/#matrix-content-mxc-uris) to the image. Omitted if there is no image.
examples:

1
data/api/client-server/definitions/public_rooms_response.yaml
View file

@ -68,6 +68,7 @@ properties:
rules like any other user.
avatar_url:
type: string
format: uri
description: The URL for the room's avatar, if one is set.
join_rule:
type: string

1
data/api/client-server/definitions/request_token_response.yaml
View file

@ -22,6 +22,7 @@ properties:
example: "123abc"
submit_url:
type: string
format: uri
description: |-
An optional field containing a URL where the client must submit the
validation token to, with identical parameters to the Identity Service

1
data/api/client-server/definitions/wellknown/homeserver.yaml
View file

@ -18,6 +18,7 @@ type: object
properties:
base_url:
type: string
format: uri
description: The base URL for the homeserver for client-server connections.
example: https://matrix.example.com
required:

1
data/api/client-server/definitions/wellknown/identity_server.yaml
View file

@ -18,6 +18,7 @@ type: object
properties:
base_url:
type: string
format: uri
description: The base URL for the identity server for client-server connections.
example: https://identity.example.com
required:

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

@ -129,6 +129,7 @@ paths:
properties:
avatar_url:
type: string
format: uri
description: The new avatar URL for this user.
responses:
200:
@ -170,6 +171,7 @@ paths:
properties:
avatar_url:
type: string
format: uri
description: The user's avatar URL if they have set one, otherwise not present.
404:
description: There is no avatar URL for this user or this user does not exist.
@ -204,6 +206,7 @@ paths:
properties:
avatar_url:
type: string
format: uri
description: The user's avatar URL if they have set one, otherwise not present.
displayname:
type: string

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

@ -113,6 +113,7 @@ paths:
properties:
url:
type: string
format: uri
description: |-
Required if `kind` is `http`. The URL to use to send
notifications to.
@ -220,6 +221,7 @@ paths:
properties:
url:
type: string
format: uri
description: |-
Required if `kind` is `http`. The URL to use to send
notifications to. MUST be an HTTPS URL with a path of

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

@ -303,6 +303,7 @@ paths:
description: The display name of the user this object is representing.
avatar_url:
type: string
format: uri
description: The mxc avatar url of the user this object is representing.
description: A map from user ID to a RoomMember object.
type: object

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

@ -238,6 +238,7 @@ paths:
title: Display name
avatar_url:
type: string
format: uri
title: Avatar Url
events_before:
type: array

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

@ -96,6 +96,7 @@ paths:
description: The display name of the user, if one exists.
avatar_url:
type: string
format: uri
example: "mxc://bar.com/foo"
description: The avatar url, as an MXC, if one exists.
limited:

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

@ -45,6 +45,7 @@ properties:
avatar_url:
description: 'The avatar URL for this user, if any.'
type: string
format: uri
displayname:
description: 'The display name for this user, if any.'
type: