9f01850f7a
Add some words about where the filter is applied
2019-11-06 10:43:11 -07:00
a1e5a96cf8
Update api/client-server/event_context.yaml
...
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2019-11-06 10:42:08 -07:00
e59bb20dc3
Try to clarify the filter information on /context
2019-11-05 16:08:15 -07:00
021c056efc
Add filter query param to /context
...
This was missed as part of lazy-loading.
Fixes https://github.com/matrix-org/matrix-doc/issues/2338
2019-11-04 15:55:20 -07:00
8f1f8b4fe5
Fix references to filtering
...
We can't have two different backlinks for the same text, so use LL as the label
2019-06-11 11:28:35 -06:00
19f017f9bd
Merge pull request #2035 from matrix-org/travis/1.0/msc688-msc1227-lazy-loading
...
Spec lazy-loading room members
2019-06-11 09:39:32 -06:00
a0e8201816
Apply suggestions from code review
...
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2019-06-07 08:27:53 -06:00
d6d74c4cbe
Switch to using $ instead of # for sub-types
...
# is reserved by the swagger validator as a way to include partial content from a JSON object (eg: "#/path" would include {"test": true} from the object {"path":{"test":true}}). Instead of trying to convince the validator that it is wrong, we'll just use a different character.
Note that our rendering tools do not care about #-style references to objects. It's still somewhat worth changing the character though.
2019-05-29 15:28:48 -06:00
c25afa663e
Use consistent event examples throughout the Client-Server API
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1968
2019-05-29 14:57:56 -06:00
c5fdd5cb0b
Change note style
2019-05-28 13:57:08 -06:00
b67161cf97
List the endpoints which are lazy-loading aware
2019-05-27 17:38:11 -06:00
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
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
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
5383754a40
Access event-schemas via a symlink
...
Swagger gets a bit confused about $refs via '../..', so use a symlink to make
everything nicely relative.
2016-05-04 14:39:52 +01:00
23c4ffbc1b
Add securityDefintions to generated swagger JSON
...
Also factor out to a common file
2016-05-03 13:57:16 +01:00
bc83677d98
Define the order for events returned by /context API
2016-02-19 16:52:03 +00:00
58b346e204
s/user_id/sender/ in context example response
2016-02-01 17:50:36 +00:00
b2e0a855cc
Add 'event' to event context API
...
also link through to the event schemas
2016-02-01 17:45:45 +00:00
972153be4f
Fix endpoint path for /context
...
s/api//
2016-01-08 14:06:53 +00:00
6025569a73
Remove unused 403 stub
2015-12-08 14:10:45 +00:00
0fb88e26f0
Add tags
2015-12-08 14:07:08 +00:00
4290882034
Remove superfluous quote
2015-12-08 14:06:59 +00:00
8e7f6d44f6
Remove v1 references
2015-12-08 14:01:16 +00:00
f4b9433c7b
Better wording
2015-12-07 16:33:48 +00:00
584104c432
Make example valid event id
2015-12-07 16:32:43 +00:00
fda07e0d41
Merge remote-tracking branch 'origin/master' into erikj/event_context_api
2015-12-07 16:31:55 +00:00
Travis Ralston