6c89e6ea67
Wrap refresh_token in `s
2015-09-25 13:03:46 +01:00
f34722485f
Check the request example JSON matches the schema
2015-09-24 16:50:27 +01:00
a31a446661
Fix the POST example for the v2 filter API
2015-09-24 16:48:00 +01:00
69298b9612
Check "v2_alpha" in jenkins
2015-09-24 16:29:51 +01:00
883105eae6
Document the v2 filter GET API
2015-09-24 16:25:03 +01:00
2f039a1142
Add swagger docs for the v2 filter POST API
2015-09-24 15:39:17 +01:00
385b6c4759
Only validate a file if it ends with ".yaml".
...
Otherwise we try to validate vim .swp files.
2015-09-24 13:37:32 +01:00
98d91d0c2b
Make the example room id more "random" so that people are less likely to think that it is supposed to be human readable
2015-09-21 17:31:35 +01:00
f60190086a
Describe the behaviour of /rooms/{roomId}/member when the user has left the room
2015-09-21 17:30:10 +01:00
ba6c7d267c
SPEC-216: Document the behaviour of the room getters when the user has left the room
2015-09-21 17:21:01 +01:00
615a9575cb
SPEC-216: Clarify when the room getters will return 403
2015-09-21 17:12:29 +01:00
cb41adee70
Fix the swagger host to be "localhost:8008" so that it can be used in a "Try it now" setup against localhost
2015-09-21 17:10:23 +01:00
6a2c4d27fc
Update the docs for room v1 api
2015-09-18 17:58:44 +01:00
f33c0846c3
Merge remote-tracking branch 'origin/master' into markjh/document_v1_rooms_api
2015-09-18 17:38:03 +01:00
f827765ba1
Make to code to skip checking swagger responses which don't have an
...
application/json example clearer.
2015-09-18 16:35:27 +01:00
9896f98e2b
Search for yaml swagger files if check_examples.py is run without
...
arguments.
2015-09-18 16:21:48 +01:00
299a4356d4
Add script to check that the example responses in the swagger matches
...
the examples.
2015-09-18 16:10:21 +01:00
63f08bace6
Fix the examples in the swagger API documentation to be valid JSON
2015-09-18 14:40:48 +01:00
7f81501762
Allow relative references to schema to work in python and node.
...
Rename "schema/v1/core" to "schema/v1/core-event-schema".
Add self-referential symlinks to schema/v1/core-event-schema
The python json schema libraries expect that relative references are
relative to the file they are in. The node json schema libraries
expect that relateive references are relative to the first file loaded.
To support both kinds we reference the core event schema using
"core-event-schema/event.json". We then symlink the core-event-schema
directory to both the location of the file refering to "event.json" so
that it will work in python and to the location of the top level file
so that it will work in node.
2015-09-18 11:39:44 +01:00
46d29e9eea
fix the room api swagger to be valid swagger
2015-09-17 16:48:07 +01:00
315f97e36b
Merge branch 'master' into markjh/document_v1_rooms_api
2015-09-17 15:25:00 +01:00
c49338006a
replace definitions/*event.yaml with symlinks to /event-schemas/
2015-09-17 13:09:35 +01:00
a19e18a4da
Merge branch 'master' into daniel/threepidinvites-2
2015-09-15 16:46:35 +01:00
2e9d3d283a
Swagger refresh tokens
2015-09-15 16:23:19 +01:00
7eb8b4fde2
Add new-style docs for the APIs for getting events for a room
2015-09-15 15:52:36 +01:00
59a4e84361
s/registration/login/
2015-09-14 17:10:46 +01:00
b916823d0f
Merge branch 'master' into daniel/threepidinvites-2
2015-09-14 17:08:22 +01:00
f483340033
Clarify digest computation
2015-09-14 15:16:30 +01:00
b8e2ac5c1b
Swaggerify /login
2015-09-14 13:49:27 +01:00
da7c2e7fa8
Merge pull request #40 from matrix-org/markjh/history_for_rooms_that_have_been_left
...
SPEC-216: Add rooms that have been left to initial sync
2015-09-11 12:55:07 +01:00
306f91edb3
Specify third party room invitations
...
SYN-458
2015-09-10 16:46:22 +01:00
5b722160dd
Merge branch 'master' into daniel/threepidinvites
2015-09-10 14:05:58 +01:00
6596802ed7
Merge branch 'newlines' into daniel/threepidinvites-2
2015-09-10 13:21:44 +01:00
6a56c8a965
Add trailing newline
2015-09-10 13:20:56 +01:00
a548148563
Invite doesn't accept room aliases
2015-09-10 11:21:18 +01:00
2797fac3aa
Swagger /room/{roomId}/invite
...
This is a transcription of the current spec, with nothing new or
controversial in it.
2015-09-09 17:55:40 +01:00
1b591a023e
Monospace room_id
2015-09-09 14:04:48 +01:00
04b2b2588f
Fix up formatting and typos
2015-09-09 13:18:23 +01:00
1feb9565e4
Use other-way-around alias format
2015-09-08 17:04:08 +01:00
d53943c8c2
Spec /room/{roomId}/join
...
This is just replacing the existing spec with a swagger version.
Subsequent pull requests will add 3pid join to this, as well as specing
the invite, leave, ban, and kick endpoints.
2015-09-08 16:35:08 +01:00
c74c1ab098
SPEC-216: Add rooms that have been left to initial sync
2015-09-07 17:09:41 +01:00
e10859a887
Replace presence API with new template.
2015-06-02 16:01:26 +01:00
334e10468d
Add presence swagger and template.
2015-06-02 15:10:44 +01:00
876a3d2bbc
Add package.json
2015-06-02 13:32:22 +01:00
3d70404b94
Update swagger validator to support directories.
...
This will be used with Jenkins.
2015-06-02 13:28:58 +01:00
0275c2ffa0
Add sync API yaml. Add template for sync_http_api.
2015-06-02 11:44:27 +01:00
8a676a2b9d
Add sortFn for profile HTTP API. Add combined profile HTTP API.
2015-06-01 16:29:19 +01:00
f6c98f41e9
Use table subsections for param locations instead of an extra column.
2015-06-01 15:26:48 +01:00
ba6ce16509
Modify how descriptions are shown. Add profile API descriptions.
2015-06-01 14:34:13 +01:00
862f5a3a53
Add structure for adding examples to HTTP APIs.
...
Use 'x-example' to add examples to parameters which are not in 'body' (swagger
doesn't define that currently). Add profile API examples. Add necessary glue
and templates to make it all work.
2015-06-01 14:20:24 +01:00
5795e1ceda
Add profile API examples and extract examples for template usage.
2015-06-01 10:44:03 +01:00
fe7ffafc15
Factor out json schema object processing since swagger uses it too. Hook swagger up.
2015-05-29 17:19:45 +01:00
d090389d01
Start pre-processing swagger APIs before passing to sections.
2015-05-29 16:50:22 +01:00
99dfe64d5c
Add rate-limiting on APIs which rate limit. More descriptions.
2015-05-29 15:48:48 +01:00
f72319e256
Add profile API. Add error definition to definitions folder.
...
The tool used for validating swagger 2.0 schemata does not currently
support deep-nested definitions from other files. Until it does, keep
the definitions in a separate file each in a definitions folder. This
will be replaced with a definitions.yaml in the future.
2015-05-29 15:37:44 +01:00
aeaa43811c
Add security definitions for directory API.
2015-05-29 15:18:09 +01:00
870d1b8944
Add Swagger 2 directory API.
2015-05-29 14:31:05 +01:00
caa84c1dc1
Add Swagger 2 docs for content repo. Add Swagger 2 CLI validator.
2015-05-29 12:15:24 +01:00
838af288c9
Test swagger commit
2015-02-20 14:29:51 +00:00
5cb656fba7
Minor swagger HTML tweaks
2015-02-20 11:32:53 +00:00
c4056bec1b
Shuffle around structure of matrix-doc and add a README.
2015-02-20 10:43:20 +00:00
Daniel Wagner-Hall