Fix a few events/endpoints schemas for better rendering

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2023-09-13 16:36:33 +02:00
parent e719219a6c
commit ffa576f932
No known key found for this signature in database
GPG key ID: 29A48C1F03620416
4 changed files with 9 additions and 10 deletions

View file

@ -162,7 +162,6 @@ paths:
application/json: application/json:
schema: schema:
type: object type: object
title: Signatures
additionalProperties: additionalProperties:
type: object type: object
additionalProperties: additionalProperties:

View file

@ -11,10 +11,12 @@ properties:
content: content:
additionalProperties: additionalProperties:
type: array type: array
title: User ID
items: items:
type: string type: string
type: object type: object
description: |-
The mapping of user ID to a list of room IDs of the 'direct' rooms for
that user ID.
type: type:
enum: enum:
- m.direct - m.direct

View file

@ -10,12 +10,10 @@ properties:
properties: properties:
ignored_users: ignored_users:
type: object type: object
title: "Ignored users"
description: "The map of users to ignore" description: "The map of users to ignore"
patternProperties: patternProperties:
"^@": "^@":
type: "object" type: "object"
title: "Ignored User"
description: "An empty object for future enhancement" description: "An empty object for future enhancement"
x-pattern: "$USER_ID" x-pattern: "$USER_ID"
required: required:

View file

@ -9,19 +9,20 @@ allOf:
properties: properties:
content: content:
type: object type: object
patternProperties:
"^\\$":
type: object
x-pattern: "$EVENT_ID"
title: Receipts
description: |- description: |-
The mapping of event ID to a collection of receipts for this 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 event ID. The event ID is the ID of the event being acknowledged
and *not* an ID for the receipt itself. and *not* an ID for the receipt itself.
patternProperties:
"^\\$":
type: object
x-pattern: "$EVENT_ID"
title: Event Receipts
description: |-
The collection of receipts for this event ID.
properties: properties:
"m.read": "m.read":
type: object type: object
title: Users
description: |- description: |-
A collection of users who have sent `m.read` receipts for A collection of users who have sent `m.read` receipts for
this event. this event.
@ -48,7 +49,6 @@ properties:
(default). (default).
"m.read.private": "m.read.private":
type: object type: object
title: Own User
description: |- description: |-
Similar to `m.read`, the users who have sent `m.read.private` Similar to `m.read`, the users who have sent `m.read.private`
receipts for this event. Due to the nature of private read receipts for this event. Due to the nature of private read