Commit graph

13 commits

Author SHA1 Message Date
Will
00c6a866e2 Move raw API and event schemas into /data directory
Historical note: this was originally a series of several commits, spread out
over several weeks. They have been squashed together to make `git annotate`
work properly.

The original commits were:
 * 91ab3934 <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory
 * aae22f47 <Will> 2021-01-25 21:33:06 -0800 Remove non-data files
 * 1092d4ca <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one
 * 21060109 <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly
 * 4f633845 <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too
 * 301c7b2f <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use
2021-08-27 19:16:39 +01:00
Aaron Raimist
a82b657a0a
Attempt to differentiate between m.room.redaction event PL and redact PL
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2020-10-14 22:44:17 -05:00
Aaron Raimist
4414d44f34
Remove duplicate description of who can redact a message and correct that description
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2020-10-12 22:30:52 -05:00
Kitsune Ral
c72d30513e c2s: Add required: true to request bodies 2020-05-25 19:08:17 +02:00
Aaron Axvig
4d808762da Change formatting from italics to code 2020-03-23 12:11:18 -04:00
Konstantinos Sideris
7448ef0db0 Use the correct event_id format on examples
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
2018-04-03 13:18:29 +03:00
Kitsune Ral
24afe7987c Add operationId to all endpoints of all APIs
To facilitate generation of API stubs from the spec.

Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
2017-10-11 01:58:31 +09:00
Richard van der Hoff
820704a16a Format examples as raw objects
According the the openapi spec, examples for responses and schemas should be
raw objects rather than being json strings. (It's unclear what non-json
examples should look like...).

The swagger UI used to support json strings, but no longer does. In short,
let's turn the json strings into their raw formats.
2017-09-27 08:04:24 +01:00
Richard van der Hoff
49cd65dd58 Add a license to the spec
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
2016-07-12 17:28:30 +01:00
Richard van der Hoff
2d28e5abce Fix basePath on /redact API doc 2016-05-06 12:39:37 +01:00
Richard van der Hoff
23c4ffbc1b Add securityDefintions to generated swagger JSON
Also factor out to a common file
2016-05-03 13:57:16 +01:00
Daniel Wagner-Hall
1f5b6271f2 Generate swagger-ui output for client-server API
Depends on:
https://github.com/matrix-org/matrix-doc/pull/212
https://github.com/matrix-org/matrix-doc/pull/208
https://github.com/matrix-org/matrix-doc/pull/207
for the actual rendered output to not throw javascript errors at runtime.
2015-12-07 12:45:13 +00:00
Daniel Wagner-Hall
e072d215cf Specify redaction 2015-12-02 15:27:25 +00:00