From ffa576f932d09ab6bd541384939006a461c6bdb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Wed, 13 Sep 2023 16:36:33 +0200 Subject: [PATCH] Fix a few events/endpoints schemas for better rendering MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Kévin Commaille --- data/api/client-server/cross_signing.yaml | 1 - data/event-schemas/schema/m.direct.yaml | 4 +++- data/event-schemas/schema/m.ignored_user_list.yaml | 2 -- data/event-schemas/schema/m.receipt.yaml | 12 ++++++------ 4 files changed, 9 insertions(+), 10 deletions(-) diff --git a/data/api/client-server/cross_signing.yaml b/data/api/client-server/cross_signing.yaml index 2f038e80..7fef6ebe 100644 --- a/data/api/client-server/cross_signing.yaml +++ b/data/api/client-server/cross_signing.yaml @@ -162,7 +162,6 @@ paths: application/json: schema: type: object - title: Signatures additionalProperties: type: object additionalProperties: diff --git a/data/event-schemas/schema/m.direct.yaml b/data/event-schemas/schema/m.direct.yaml index f00b83bc..3256b574 100644 --- a/data/event-schemas/schema/m.direct.yaml +++ b/data/event-schemas/schema/m.direct.yaml @@ -11,10 +11,12 @@ properties: content: additionalProperties: type: array - title: User ID items: type: string type: object + description: |- + The mapping of user ID to a list of room IDs of the 'direct' rooms for + that user ID. type: enum: - m.direct diff --git a/data/event-schemas/schema/m.ignored_user_list.yaml b/data/event-schemas/schema/m.ignored_user_list.yaml index 0f0b2f85..56e7adc3 100644 --- a/data/event-schemas/schema/m.ignored_user_list.yaml +++ b/data/event-schemas/schema/m.ignored_user_list.yaml @@ -10,12 +10,10 @@ properties: properties: ignored_users: type: object - title: "Ignored users" description: "The map of users to ignore" patternProperties: "^@": type: "object" - title: "Ignored User" description: "An empty object for future enhancement" x-pattern: "$USER_ID" required: diff --git a/data/event-schemas/schema/m.receipt.yaml b/data/event-schemas/schema/m.receipt.yaml index 6062d31f..5d738923 100644 --- a/data/event-schemas/schema/m.receipt.yaml +++ b/data/event-schemas/schema/m.receipt.yaml @@ -9,19 +9,20 @@ allOf: properties: content: type: object + description: |- + The mapping of event ID to a collection of receipts for this + event ID. The event ID is the ID of the event being acknowledged + and *not* an ID for the receipt itself. patternProperties: "^\\$": type: object x-pattern: "$EVENT_ID" - title: Receipts + title: Event Receipts description: |- - The mapping of event ID to a collection of receipts for this - event ID. The event ID is the ID of the event being acknowledged - and *not* an ID for the receipt itself. + The collection of receipts for this event ID. properties: "m.read": type: object - title: Users description: |- A collection of users who have sent `m.read` receipts for this event. @@ -48,7 +49,6 @@ properties: (default). "m.read.private": type: object - title: Own User description: |- Similar to `m.read`, the users who have sent `m.read.private` receipts for this event. Due to the nature of private read