wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Arrange a few titles (#1126)

Browse source 
* Arrange a few titles

Before this change, PublicRoomsChunk in the spec text could be found in
two places (actually three but the third one is identical to the first
one), defining two (_mostly_ identical but) different schemas.
Ctrl-F'ing through the spec may confuse you with the "wrong" definition.
This commit gives distinct schemas distinct names; aside from
PublicRoomChunk, the same story happens with the derivative of
stripped_state.yaml used in space_hierarchy.yaml (it's not exactly
StrippedStateEvent either).

As for the removal of `PublicRoomsChunks` (plural) - this title is
unnecessary because the tooling would place rather self-explanatory
`[PublicRoomsChunk]` without it, whereas the plural title ends up with
no definition in the spec text.

* Add changelog
This commit is contained in:
Alexey Rusakov 2022-06-15 06:04:10 +02:00 • committed by GitHub
parent dcc1f4adee
commit 6adacd18c1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/1126.clarification Normal file
View file

@ -0,0 +1 @@
Fix various typos throughout the specification.

2
data/api/client-server/definitions/public_rooms_response.yaml
View file

@ -17,7 +17,6 @@ description: A list of the rooms on the server.
required: ["chunk"] required: ["chunk"]
properties: properties:
chunk: chunk:
title: "PublicRoomsChunks"
type: array type: array
description: |- description: |-
A paginated chunk of public rooms. A paginated chunk of public rooms.
@ -25,6 +24,7 @@ properties:
allOf: allOf:
- $ref: "public_rooms_chunk.yaml" - $ref: "public_rooms_chunk.yaml"
- type: object - type: object
title: PublicRoomsChunk
properties: properties:
# Override description of join_rule # Override description of join_rule
join_rule: join_rule:

2
data/api/client-server/space_hierarchy.yaml
View file

@ -127,6 +127,7 @@ paths:
allOf: allOf:
- $ref: "definitions/public_rooms_chunk.yaml" - $ref: "definitions/public_rooms_chunk.yaml"
- type: object - type: object
title: ChildRoomsChunk
properties: properties:
room_type: room_type:
type: string type: string
@ -143,6 +144,7 @@ paths:
allOf: allOf:
- $ref: "../../event-schemas/schema/core-event-schema/stripped_state.yaml" - $ref: "../../event-schemas/schema/core-event-schema/stripped_state.yaml"
- type: object - type: object
title: StrippedChildStateEvent
properties: properties:
origin_server_ts: origin_server_ts:
type: number type: number