OpenAPI: use uri format

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

Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
pull/3236/head
Lukas Lihotzki 3 years ago
parent c651d394d1
commit 29465f3519

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

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

@ -68,6 +68,7 @@ properties:
rules like any other user. rules like any other user.
avatar_url: avatar_url:
type: string type: string
format: uri
description: The URL for the room's avatar, if one is set. description: The URL for the room's avatar, if one is set.
join_rule: join_rule:
type: string type: string
@ -110,4 +111,4 @@ example: {
"next_batch": "p190q", "next_batch": "p190q",
"prev_batch": "p1902", "prev_batch": "p1902",
"total_room_count_estimate": 115 "total_room_count_estimate": 115
} }

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

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

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

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

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

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

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

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

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

Loading…
Cancel
Save