Commit graph

23 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
Travis Ralston
2d047e312f Add membership reasons to the spec for all membership events
MSC: https://github.com/matrix-org/matrix-doc/pull/2367
2020-09-30 13:43:56 -06:00
Kitsune Ral
48af2e5b47 joining.yaml: put descriptions next to their properties
Fixing the problem described in https://github.com/matrix-org/matrix-doc/pull/2518#issuecomment-621684187
2020-05-28 14:17:01 +02:00
Kitsune Ral
c72d30513e c2s: Add required: true to request bodies 2020-05-25 19:08:17 +02:00
Kitsune Ral
202bf8abb1 Cleanup summaries and descriptions 2020-04-29 20:15:06 +02:00
Travis Ralston
2b96d73305 Fix third party signed definitions for join APIs
Fixes https://github.com/matrix-org/matrix-doc/issues/1978
2019-05-26 15:39:35 -06:00
Kitsune Ral
6782b6399f
Update according to the comments 2018-11-23 17:54:00 +09:00
Kitsune Ral
96d7eed1c6 joining.yaml: add missing response schema details 2018-11-17 19:21:08 +09:00
Travis Ralston
ab75fc4b20 Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 2018-07-06 08:46:50 -06:00
Travis Ralston
caa6d4d9ad Give all errors a schema reference
This just helps keep an overall structure
2018-07-04 13:54:52 -06:00
Travis Ralston
7cd22f5690 Describe the rate limit error everywhere
Fixes https://github.com/matrix-org/matrix-doc/issues/1153
2018-07-04 13:45:34 -06:00
Travis Ralston
a6b0125da6 Our swagger doesn't support explode yet 2018-07-03 16:19:31 -06:00
Travis Ralston
d279fdafa6 Document the server_name query parameter on /join/{roomIdOrAlias}
Fixes https://github.com/matrix-org/matrix-doc/issues/904
2018-07-03 15:49:16 -06: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
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
016ccf4544 Remove signed object which shouldn't exist 2016-02-23 15:19:45 +00:00
Daniel Wagner-Hall
ccac9e7882 /join accepts a signature for a third party invite 2016-02-22 14:54:23 +00:00
Daniel Wagner-Hall
1e2b63763e /join and /room/:roomId/join aren't exact aliases
Separate them, clarify their differences.

Also, fix some links which weren't being properly populated.
2016-01-13 15:55:51 +00: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
873b0dcecf Replace version numbers with release numbers 2015-12-04 11:09:35 +00:00
Daniel Wagner-Hall
6c66bfc755 Flatten out v1 and v2_alpha directories
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
2015-11-30 11:22:57 +00:00
Renamed from api/client-server/v1/joining.yaml (Browse further)