From 763e5654cc00e97345169a9da7791eebeec4dcb8 Mon Sep 17 00:00:00 2001 From: Jonas Platte Date: Fri, 19 Jun 2020 20:09:39 +0200 Subject: [PATCH] Make event's title fields UpperCamelCase and distinguish /sync ones --- api/server-server/definitions/invite_event.yaml | 2 +- changelogs/client_server/newsfragments/2647.clarification | 1 + event-schemas/schema/core-event-schema/room_event.yaml | 2 +- event-schemas/schema/core-event-schema/state_event.yaml | 2 +- event-schemas/schema/core-event-schema/sync_room_event.yaml | 2 +- event-schemas/schema/core-event-schema/sync_state_event.yaml | 2 +- 6 files changed, 6 insertions(+), 5 deletions(-) create mode 100644 changelogs/client_server/newsfragments/2647.clarification diff --git a/api/server-server/definitions/invite_event.yaml b/api/server-server/definitions/invite_event.yaml index 674ef2c9..dd2efdd6 100644 --- a/api/server-server/definitions/invite_event.yaml +++ b/api/server-server/definitions/invite_event.yaml @@ -12,7 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. type: object -title: Invite Event +title: InviteEvent description: |- An invite event. Note that events have a different format depending on the room version - check the `room version specification`_ for precise event formats. diff --git a/changelogs/client_server/newsfragments/2647.clarification b/changelogs/client_server/newsfragments/2647.clarification new file mode 100644 index 00000000..a79ec474 --- /dev/null +++ b/changelogs/client_server/newsfragments/2647.clarification @@ -0,0 +1 @@ +Improve consistency and clarity of event schema ``title``s. diff --git a/event-schemas/schema/core-event-schema/room_event.yaml b/event-schemas/schema/core-event-schema/room_event.yaml index 231d5c65..6a74acdc 100644 --- a/event-schemas/schema/core-event-schema/room_event.yaml +++ b/event-schemas/schema/core-event-schema/room_event.yaml @@ -9,5 +9,5 @@ properties: type: string required: - room_id -title: Room Event +title: RoomEvent type: object diff --git a/event-schemas/schema/core-event-schema/state_event.yaml b/event-schemas/schema/core-event-schema/state_event.yaml index 816f925f..d2ff5243 100644 --- a/event-schemas/schema/core-event-schema/state_event.yaml +++ b/event-schemas/schema/core-event-schema/state_event.yaml @@ -2,5 +2,5 @@ allOf: - $ref: room_event.yaml - $ref: sync_state_event.yaml description: State Events have the following fields. -title: State Event +title: StateEvent type: object diff --git a/event-schemas/schema/core-event-schema/sync_room_event.yaml b/event-schemas/schema/core-event-schema/sync_room_event.yaml index fef13ad0..7ad7191b 100644 --- a/event-schemas/schema/core-event-schema/sync_room_event.yaml +++ b/event-schemas/schema/core-event-schema/sync_room_event.yaml @@ -39,5 +39,5 @@ required: - event_id - sender - origin_server_ts -title: Room Event +title: SyncRoomEvent type: object diff --git a/event-schemas/schema/core-event-schema/sync_state_event.yaml b/event-schemas/schema/core-event-schema/sync_state_event.yaml index 1b6ce9b2..dc48f941 100644 --- a/event-schemas/schema/core-event-schema/sync_state_event.yaml +++ b/event-schemas/schema/core-event-schema/sync_state_event.yaml @@ -35,5 +35,5 @@ properties: type: string required: - state_key -title: State Event +title: SyncStateEvent type: object