Merge 3c17aa3789 into fb4a0d8f66

changelogs/application_service/newsfragments/2182.clarification

@@ -1 +0,0 @@
-Minor fixes to JSON schemas.

changelogs/client_server/newsfragments/2182.clarification

@@ -1 +0,0 @@
-Minor fixes to JSON schemas.

data/api/application-service/definitions/protocol.yaml

@@ -23,4 +23,3 @@ allOf:
       type: array
       items:
         $ref: protocol_instance.yaml
-  required: ['instances']

data/api/application-service/definitions/protocol_base.yaml

@@ -77,4 +77,4 @@ properties:
         "placeholder": "#foobar"
       }
     }
-required: ['user_fields', 'location_fields', 'icon', 'field_types']
+required: ['user_fields', 'location_fields', 'icon', 'field_types', 'instances']

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

@@ -41,4 +41,3 @@ allOf:
                   This is the identifier to use as the `third_party_instance_id` in a request to
                   [`POST /_matrix/client/v3/publicRooms`](/client-server-api/#post_matrixclientv3publicrooms).
                 example: "irc-freenode"
-  required: ['instances']

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

@@ -42,3 +42,9 @@ allOf:
       room_version:
         description: The version of the room.
         type: string
+
+required:
+  - room_id
+  - num_joined_members
+  - world_readable
+  - guest_can_join

data/api/client-server/room_summary.yaml

@@ -89,6 +89,11 @@ paths:
                           - leave
                           - ban
                         type: string
+                required:
+                  - guest_can_join
+                  - num_joined_members
+                  - room_id
+                  - world_readable
               examples:
                 response:
                   value: {

data/event-schemas/schema/core-event-schema/room_event.yaml

@@ -1,13 +1,13 @@
-title: RoomEvent
-description: Room Events have the following fields.
 allOf:
 - $ref: sync_room_event.yaml
-- type: object
+description: Room Events have the following fields.
-  properties:
+properties:
-    room_id:
+  room_id:
-      description: |-
+    description: |-
-        The ID of the room associated with this event. Will not be present on events
+      The ID of the room associated with this event. Will not be present on events
-        that arrive through `/sync`, despite being required everywhere else.
+      that arrive through `/sync`, despite being required everywhere else.
-      type: string
+    type: string
-  required:
+required:
-  - room_id
+- room_id
+title: RoomEvent
+type: object

data/event-schemas/schema/core-event-schema/sync_room_event.yaml

@@ -17,27 +17,27 @@
 # be on events, so we give it a whole event structure as a base for room_event.
 # This base doesn't declare a room_id, which instead appears in the room_event.
 
-title: SyncRoomEvent
-description: In addition to the Event fields, Room Events have the following additional
-  fields.
 allOf:
 - $ref: event.yaml
-- type: object
+description: In addition to the Event fields, Room Events have the following additional
-  properties:
+  fields.
-    event_id:
+properties:
-      description: The globally unique event identifier.
+  event_id:
-      type: string
+    description: The globally unique event identifier.
-    sender:
+    type: string
-      description: Contains the fully-qualified ID of the user who sent this event.
+  sender:
-      type: string
+    description: Contains the fully-qualified ID of the user who sent this event.
-    origin_server_ts:
+    type: string
-      description: Timestamp in milliseconds on originating homeserver
+  origin_server_ts:
-        when this event was sent.
+    description: Timestamp in milliseconds on originating homeserver
-      type: integer
+      when this event was sent.
-      format: int64
+    type: integer
-    unsigned:
+    format: int64
-      $ref: unsigned_prop.yaml
+  unsigned:
-  required:
+    $ref: unsigned_prop.yaml
-  - event_id
+required:
-  - sender
+- event_id
-  - origin_server_ts
+- sender
+- origin_server_ts
+title: SyncRoomEvent
+type: object

data/event-schemas/schema/core-event-schema/sync_state_event.yaml

@@ -14,21 +14,21 @@
 
 # See sync_room_event.yaml for why this file is here.
 
-title: SyncStateEvent
-description: In addition to the Room Event fields, State Events have the following
-  additional fields.
 allOf:
 - $ref: sync_room_event.yaml
-- type: object
+description: In addition to the Room Event fields, State Events have the following
-  properties:
+  additional fields.
-    state_key:
+properties:
-      description: A unique key which defines the overwriting semantics for this piece
+  state_key:
-        of room state. This value is often a zero-length string. The presence of this
+    description: A unique key which defines the overwriting semantics for this piece
-        key makes this event a State Event.
+      of room state. This value is often a zero-length string. The presence of this
+      key makes this event a State Event.
 
-        State keys starting with an `@` are reserved for referencing user IDs, such
+      State keys starting with an `@` are reserved for referencing user IDs, such
-        as room members. With the exception of a few events, state events set with a
+      as room members. With the exception of a few events, state events set with a
-        given user's ID as the state key MUST only be set by that user.
+      given user's ID as the state key MUST only be set by that user.
-      type: string
+    type: string
-  required:
+required:
-  - state_key
+- state_key
+title: SyncStateEvent
+type: object