Fix new redocly lints (#2182)
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
This commit is contained in:
Kévin Commaille 2025-07-29 19:22:26 +02:00 committed by GitHub
parent fb4a0d8f66
commit 7d2de48cb4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 54 additions and 61 deletions

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -1,13 +1,13 @@
title: RoomEvent
description: Room Events have the following fields.
allOf: allOf:
- $ref: sync_room_event.yaml - $ref: sync_room_event.yaml
description: Room Events have the following fields. - type: object
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

View file

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

View file

@ -14,21 +14,21 @@
# See sync_room_event.yaml for why this file is here. # See sync_room_event.yaml for why this file is here.
allOf: title: SyncStateEvent
- $ref: sync_room_event.yaml
description: In addition to the Room Event fields, State Events have the following description: In addition to the Room Event fields, State Events have the following
additional fields. additional fields.
properties: allOf:
state_key: - $ref: sync_room_event.yaml
description: A unique key which defines the overwriting semantics for this piece - type: object
of room state. This value is often a zero-length string. The presence of this properties:
key makes this event a State Event. state_key:
description: A unique key which defines the overwriting semantics for this piece
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