OpenAPI: use uri format

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

Signed-off-by: Lukas Lihotzki <[email protected]>

Author: lukaslihotzki

data/api/client-server/administrative_contact.yaml

@@ -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

data/api/client-server/content-repo.yaml

@@ -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:

data/api/client-server/definitions/public_rooms_response.yaml

@@ -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
@@ -110,4 +111,4 @@ example: {
   "next_batch": "p190q",
   "prev_batch": "p1902",
   "total_room_count_estimate": 115
-}
+}

data/api/client-server/definitions/request_token_response.yaml

@@ -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

data/api/client-server/definitions/wellknown/homeserver.yaml

@@ -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:

data/api/client-server/definitions/wellknown/identity_server.yaml

@@ -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:

data/api/client-server/profile.yaml

@@ -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

data/api/client-server/pusher.yaml

@@ -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

data/api/client-server/rooms.yaml

@@ -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

data/api/client-server/search.yaml

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