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

Dump additional apis (#3684)

Browse source 
* ✨ Allow JSON generation for all API

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 👷 Export AS API JSON

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* ✨ Handle missing security definitions

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 👷 Export Push Gateway API JSON

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 🎨 Improve identation

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 🐛 Fix successive reference handling

Fixes #3689

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 👷 Export Server-Server API JSON

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 📝 Remove obsolete comment

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 🐛 Make properties objects, as they MUST be

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* Revert "👷 Export Server-Server API JSON"

This reverts commit 061f91c2cbcb6dff35c74177226da106826b4214.

Co-authored-by: Alexandre Franke <alexandre.franke@matrix.org>
This commit is contained in:
Alexandre Franke 2022-02-02 16:51:07 +01:00 • committed by GitHub
parent 0f9eadd1a1
commit de9cf76a57
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 67 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

4
data/api/server-server/definitions/send_join_response.yaml
View file

@ -34,7 +34,7 @@ properties:
on the room version - check the [room version specification](/rooms) for precise event formats.
schema:
type: object
properties: []
properties: {}
example:
$ref: "../examples/minimal_pdu.json"
state:
@ -52,7 +52,7 @@ properties:
on the room version - check the [room version specification](/rooms) for precise event formats.
schema:
type: object
properties: []
properties: {}
example:
$ref: "../examples/minimal_pdu.json"
event:

2
data/api/server-server/definitions/single_pdu_transaction.yaml
View file

@ -26,7 +26,7 @@ properties:
description: |-
The [PDUs](/server-server-api/#pdus) contained in the transaction. The event format varies depending
on the room version - check the [room version specification](/rooms) for precise event formats.
properties: []
properties: {}
example:
$ref: "../examples/minimal_pdu.json"
required: ['origin', 'origin_server_ts', 'pdus']

2
data/api/server-server/definitions/transaction.yaml
View file

@ -41,7 +41,7 @@ properties:
description: |-
The [PDUs](/server-server-api/#pdus) contained in the transaction. The event format varies depending
on the room version - check the [room version specification](/rooms) for precise event formats.
properties: []
properties: {}
example:
$ref: "../examples/minimal_pdu.json"
required: ['origin', 'origin_server_ts', 'pdus']

2
data/api/server-server/definitions/unlimited_pdu_transaction.yaml
View file

@ -27,7 +27,7 @@ properties:
description: |-
The [PDUs](/server-server-api/#pdus) contained in the transaction. The event format varies depending
on the room version - check the [room version specification](/rooms) for precise event formats.
properties: []
properties: {}
example:
$ref: "../examples/minimal_pdu.json"
required: ['origin', 'origin_server_ts', 'pdus']

2
data/api/server-server/event_auth.yaml
View file

@ -64,7 +64,7 @@ paths:
items:
type: object
title: PDU
properties: []
properties: {}
example:
$ref: "examples/minimal_pdu.json"
required: ['auth_chain']

4
data/api/server-server/events.yaml
View file

@ -69,7 +69,7 @@ paths:
The [PDUs](/server-server-api/#pdus) contained in the auth chain. The event format
varies depending on the room version - check the [room version specification](/rooms)
for precise event formats.
properties: []
properties: {}
example:
$ref: "examples/minimal_pdu.json"
pdus:
@ -85,7 +85,7 @@ paths:
The [PDUs](/server-server-api/#pdus) for the fully resolved state of the room. The event format
varies depending on the room version - check the [room version specification](/rooms)
for precise event formats.
properties: []
properties: {}
example:
$ref: "examples/minimal_pdu.json"
required: ['auth_chain', 'pdus']

2
data/api/server-server/transactions.yaml
View file

@ -69,7 +69,7 @@ paths:
$ref: "definitions/edu.yaml"
example: {
"$ref": "examples/transaction.json",
"edus": [{"$ref": "edu.json"}] # Relative to the examples directory
"edus": [{"$ref": "examples/edu.json"}]
}
responses:
200: