Skip to content

Commit 7d2de48

Browse files
zecakehrichvdh
andauthored
Fix new redocly lints (#2182)
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
1 parent fb4a0d8 commit 7d2de48

File tree

10 files changed

+54
-61
lines changed

10 files changed

+54
-61
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Minor fixes to JSON schemas.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Minor fixes to JSON schemas.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,4 @@ allOf:
2323
type: array
2424
items:
2525
$ref: protocol_instance.yaml
26+
required: ['instances']

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,4 @@ properties:
7777
"placeholder": "#foobar"
7878
}
7979
}
80-
required: ['user_fields', 'location_fields', 'icon', 'field_types', 'instances']
80+
required: ['user_fields', 'location_fields', 'icon', 'field_types']

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ allOf:
3737
A unique identifier for this instance on the homeserver. This field is added
3838
to the response of [`GET /_matrix/app/v1/thirdparty/protocol/{protocol}`](/application-service-api/#get_matrixappv1thirdpartyprotocolprotocol)
3939
by the homeserver.
40-
40+
4141
This is the identifier to use as the `third_party_instance_id` in a request to
4242
[`POST /_matrix/client/v3/publicRooms`](/client-server-api/#post_matrixclientv3publicrooms).
4343
example: "irc-freenode"
44+
required: ['instances']

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

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,3 @@ allOf:
4242
room_version:
4343
description: The version of the room.
4444
type: string
45-
46-
required:
47-
- room_id
48-
- num_joined_members
49-
- world_readable
50-
- guest_can_join

data/api/client-server/room_summary.yaml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,6 @@ paths:
8989
- leave
9090
- ban
9191
type: string
92-
required:
93-
- guest_can_join
94-
- num_joined_members
95-
- room_id
96-
- world_readable
9792
examples:
9893
response:
9994
value: {
Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1+
title: RoomEvent
2+
description: Room Events have the following fields.
13
allOf:
24
- $ref: sync_room_event.yaml
3-
description: Room Events have the following fields.
4-
properties:
5-
room_id:
6-
description: |-
7-
The ID of the room associated with this event. Will not be present on events
8-
that arrive through `/sync`, despite being required everywhere else.
9-
type: string
10-
required:
11-
- room_id
12-
title: RoomEvent
13-
type: object
5+
- type: object
6+
properties:
7+
room_id:
8+
description: |-
9+
The ID of the room associated with this event. Will not be present on events
10+
that arrive through `/sync`, despite being required everywhere else.
11+
type: string
12+
required:
13+
- room_id

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

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -17,27 +17,27 @@
1717
# be on events, so we give it a whole event structure as a base for room_event.
1818
# This base doesn't declare a room_id, which instead appears in the room_event.
1919

20-
allOf:
21-
- $ref: event.yaml
20+
title: SyncRoomEvent
2221
description: In addition to the Event fields, Room Events have the following additional
2322
fields.
24-
properties:
25-
event_id:
26-
description: The globally unique event identifier.
27-
type: string
28-
sender:
29-
description: Contains the fully-qualified ID of the user who sent this event.
30-
type: string
31-
origin_server_ts:
32-
description: Timestamp in milliseconds on originating homeserver
33-
when this event was sent.
34-
type: integer
35-
format: int64
36-
unsigned:
37-
$ref: unsigned_prop.yaml
38-
required:
39-
- event_id
40-
- sender
41-
- origin_server_ts
42-
title: SyncRoomEvent
43-
type: object
23+
allOf:
24+
- $ref: event.yaml
25+
- type: object
26+
properties:
27+
event_id:
28+
description: The globally unique event identifier.
29+
type: string
30+
sender:
31+
description: Contains the fully-qualified ID of the user who sent this event.
32+
type: string
33+
origin_server_ts:
34+
description: Timestamp in milliseconds on originating homeserver
35+
when this event was sent.
36+
type: integer
37+
format: int64
38+
unsigned:
39+
$ref: unsigned_prop.yaml
40+
required:
41+
- event_id
42+
- sender
43+
- origin_server_ts

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@
1414

1515
# See sync_room_event.yaml for why this file is here.
1616

17-
allOf:
18-
- $ref: sync_room_event.yaml
17+
title: SyncStateEvent
1918
description: In addition to the Room Event fields, State Events have the following
2019
additional fields.
21-
properties:
22-
state_key:
23-
description: A unique key which defines the overwriting semantics for this piece
24-
of room state. This value is often a zero-length string. The presence of this
25-
key makes this event a State Event.
20+
allOf:
21+
- $ref: sync_room_event.yaml
22+
- type: object
23+
properties:
24+
state_key:
25+
description: A unique key which defines the overwriting semantics for this piece
26+
of room state. This value is often a zero-length string. The presence of this
27+
key makes this event a State Event.
2628

27-
State keys starting with an `@` are reserved for referencing user IDs, such
28-
as room members. With the exception of a few events, state events set with a
29-
given user's ID as the state key MUST only be set by that user.
30-
type: string
31-
required:
32-
- state_key
33-
title: SyncStateEvent
34-
type: object
29+
State keys starting with an `@` are reserved for referencing user IDs, such
30+
as room members. With the exception of a few events, state events set with a
31+
given user's ID as the state key MUST only be set by that user.
32+
type: string
33+
required:
34+
- state_key

0 commit comments

Comments
 (0)