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

Access event-schemas via a symlink

Browse source 
Swagger gets a bit confused about $refs via '../..', so use a symlink to make
everything nicely relative.
This commit is contained in:
Richard van der Hoff 2016-05-04 14:28:11 +01:00
parent 986f5df82e
commit 5383754a40
7 changed files with 23 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

1
api/client-server/definitions/event-schemas Symbolic link
View file

@ -0,0 +1 @@
../../../event-schemas

8
api/client-server/event_context.yaml
View file

@ -64,12 +64,12 @@ paths:
requested event, in reverse-chronological order. requested event, in reverse-chronological order.
items: items:
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/room_event.yaml"
event: event:
description: |- description: |-
Details of the requested event. Details of the requested event.
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/room_event.yaml"
events_after: events_after:
type: array type: array
description: |- description: |-
@ -77,14 +77,14 @@ paths:
requested event, in chronological order. requested event, in chronological order.
items: items:
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/room_event.yaml"
state: state:
type: array type: array
description: |- description: |-
The state of the room at the last event returned. The state of the room at the last event returned.
items: items:
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/state_event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/state_event.yaml"
examples: examples:
application/json: |- application/json: |-
{ {

14
api/client-server/old_sync.yaml
View file

@ -80,7 +80,7 @@ paths:
type: object type: object
title: Event title: Event
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/room_event.yaml"
400: 400:
description: "Bad pagination ``from`` parameter." description: "Bad pagination ``from`` parameter."
tags: tags:
@ -283,7 +283,7 @@ paths:
type: object type: object
title: Event title: Event
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/event.yaml"
rooms: rooms:
type: array type: array
items: items:
@ -302,7 +302,7 @@ paths:
title: "InviteEvent" title: "InviteEvent"
description: "The invite event if ``membership`` is ``invite``" description: "The invite event if ``membership`` is ``invite``"
allOf: allOf:
- "$ref": "../../event-schemas/schema/m.room.member" - "$ref": "definitions/event-schemas/schema/m.room.member"
messages: messages:
type: object type: object
title: PaginationChunk title: PaginationChunk
@ -330,7 +330,7 @@ paths:
type: object type: object
title: RoomEvent title: RoomEvent
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/room_event.yaml"
required: ["start", "end", "chunk"] required: ["start", "end", "chunk"]
state: state:
type: array type: array
@ -343,7 +343,7 @@ paths:
title: StateEvent title: StateEvent
type: object type: object
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/state_event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/state_event.yaml"
visibility: visibility:
type: string type: string
enum: ["private", "public"] enum: ["private", "public"]
@ -359,7 +359,7 @@ paths:
title: Event title: Event
type: object type: object
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/event.yaml"
required: ["room_id", "membership"] required: ["room_id", "membership"]
required: ["end", "rooms", "presence"] required: ["end", "rooms", "presence"]
404: 404:
@ -399,7 +399,7 @@ paths:
} }
schema: schema:
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/event.yaml"
404: 404:
description: The event was not found or you do not have permission to read this event. description: The event was not found or you do not have permission to read this event.
tags: tags:

2
api/client-server/peeking_events.yaml
View file

@ -95,7 +95,7 @@ paths:
type: object type: object
title: Event title: Event
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/room_event.yaml"
400: 400:
description: "Bad pagination ``from`` parameter." description: "Bad pagination ``from`` parameter."
# No tags to exclude this from the swagger UI - use the normal version instead. # No tags to exclude this from the swagger UI - use the normal version instead.

2
api/client-server/presence.yaml
View file

@ -206,6 +206,6 @@ paths:
type: object type: object
title: PresenceEvent title: PresenceEvent
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/event.yaml"
tags: tags:
- Presence - Presence

10
api/client-server/rooms.yaml
View file

@ -210,7 +210,7 @@ paths:
title: StateEvent title: StateEvent
type: object type: object
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/state_event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/state_event.yaml"
403: 403:
description: > description: >
You aren't a member of the room and weren't previously a You aren't a member of the room and weren't previously a
@ -392,7 +392,7 @@ paths:
type: object type: object
title: RoomEvent title: RoomEvent
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/room_event.yaml"
required: ["start", "end", "chunk"] required: ["start", "end", "chunk"]
state: state:
type: array type: array
@ -405,7 +405,7 @@ paths:
title: StateEvent title: StateEvent
type: object type: object
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/state_event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/state_event.yaml"
visibility: visibility:
type: string type: string
enum: ["private", "public"] enum: ["private", "public"]
@ -420,7 +420,7 @@ paths:
title: Event title: Event
type: object type: object
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/event.yaml"
required: ["room_id"] required: ["room_id"]
403: 403:
description: > description: >
@ -491,7 +491,7 @@ paths:
title: MemberEvent title: MemberEvent
type: object type: object
allOf: allOf:
- "$ref": "../../event-schemas/schema/m.room.member" - "$ref": "definitions/event-schemas/schema/m.room.member"
403: 403:
description: > description: >
You aren't a member of the room and weren't previously a You aren't a member of the room and weren't previously a

8
api/client-server/search.yaml
View file

@ -180,7 +180,7 @@ paths:
title: Event title: Event
description: The event that matched. description: The event that matched.
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/room_event.yaml"
context: context:
type: object type: object
title: Event Context title: Event Context
@ -220,7 +220,7 @@ paths:
type: object type: object
title: Event title: Event
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/room_event.yaml"
events_after: events_after:
type: array type: array
title: Events After title: Events After
@ -229,7 +229,7 @@ paths:
type: object type: object
title: Event title: Event
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/room_event.yaml"
state: state:
type: object type: object
title: Current state title: Current state
@ -244,7 +244,7 @@ paths:
type: object type: object
title: Event title: Event
allOf: allOf:
- "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml" - "$ref": "definitions/event-schemas/schema/core-event-schema/room_event.yaml"
groups: groups:
type: object type: object
title: Groups title: Groups