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

fix the room api swagger to be valid swagger

Browse source
This commit is contained in:
Mark Haines 2015-09-17 16:48:07 +01:00
parent 654ed9b99e
commit 46d29e9eea
1 changed files with 19 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

41
api/client-server/v1/rooms.yaml
View file

@ -43,9 +43,8 @@ paths:
- in: path - in: path
type: string type: string
name: stateKey name: stateKey
description: |- description: The key of the state to look up. Defaults to the empty string.
The key of the state to look up. Defaults to the empty string. required: true
required: false
x-example: "" x-example: ""
responses: responses:
200: 200:
@ -159,17 +158,17 @@ paths:
"user_id": "@alice:example.com" "user_id": "@alice:example.com"
} }
] ]
schema: schema:
type: array type: array
title: RoomState title: RoomState
description: |- description: |-
If the user is a member of the room this will be the If the user is a member of the room this will be the
current state of the room as a list of events. current state of the room as a list of events.
items: items:
title: StateEvent title: StateEvent
type: object type: object
allOf: allOf:
- "$ref": "definitions/state_event.yaml" - "$ref": "events/core/state_event.json"
403: 403:
description: You are not joined to the room. description: You are not joined to the room.
@ -345,7 +344,7 @@ paths:
type: object type: object
title: RoomEvent title: RoomEvent
allOf: allOf:
- "$ref": "definitions/room_event.yaml" - "$ref": "events/core/room_event.json"
required: ["start", "end", "chunk"] required: ["start", "end", "chunk"]
state: state:
type: array type: array
@ -358,7 +357,7 @@ paths:
title: StateEvent title: StateEvent
type: object type: object
allOf: allOf:
- "$ref": "definitions/state_event.yaml" - "$ref": "events/core/state_event.json"
visibility: visibility:
type: string type: string
enum: ["private", "public"] enum: ["private", "public"]
@ -377,7 +376,7 @@ paths:
type: string type: string
name: roomId name: roomId
description: The room to get the member events for. description: The room to get the member events for.
required: true, required: true
x-example: "!room:example.com" x-example: "!room:example.com"
responses: responses:
200: 200:
@ -419,15 +418,13 @@ paths:
] ]
} }
schema: schema:
object: type: object
properities: properties:
chunk: chunk:
type: array type: array
items: items:
title: MemberEvent title: MemberEvent
type: object type: object
allOf: allOf:
- "$ref": "../../event-schemas/schema/v1/m.room.member" - "$ref": "events/m.room.member"
visibility:
type: string