Commit Graph

349 Commits (a8eed29e9fd5eaefc43335e813fbf2dca374d50d)

Author SHA1 Message Date
Mark Haines 6a2c4d27fc Update the docs for room v1 api 9 years ago
Mark Haines f33c0846c3 Merge remote-tracking branch 'origin/master' into markjh/document_v1_rooms_api 9 years ago
Mark Haines f827765ba1 Make to code to skip checking swagger responses which don't have an
application/json example clearer.
9 years ago
Mark Haines 9896f98e2b Search for yaml swagger files if check_examples.py is run without
arguments.
9 years ago
Mark Haines 299a4356d4 Add script to check that the example responses in the swagger matches
the examples.
9 years ago
Mark Haines 63f08bace6 Fix the examples in the swagger API documentation to be valid JSON 9 years ago
Mark Haines 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.
9 years ago
Mark Haines 46d29e9eea fix the room api swagger to be valid swagger 9 years ago
Mark Haines 315f97e36b Merge branch 'master' into markjh/document_v1_rooms_api 9 years ago
Mark Haines c49338006a replace definitions/*event.yaml with symlinks to /event-schemas/ 9 years ago
Daniel Wagner-Hall a19e18a4da Merge branch 'master' into daniel/threepidinvites-2 9 years ago
Daniel Wagner-Hall 2e9d3d283a Swagger refresh tokens 9 years ago
Mark Haines 7eb8b4fde2 Add new-style docs for the APIs for getting events for a room 9 years ago
Daniel Wagner-Hall 59a4e84361 s/registration/login/ 9 years ago
Daniel Wagner-Hall b916823d0f Merge branch 'master' into daniel/threepidinvites-2 9 years ago
Daniel Wagner-Hall f483340033 Clarify digest computation 9 years ago
Daniel Wagner-Hall b8e2ac5c1b Swaggerify /login 9 years ago
Kegsay 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
9 years ago
Daniel Wagner-Hall 306f91edb3 Specify third party room invitations
SYN-458
9 years ago
Daniel Wagner-Hall 5b722160dd Merge branch 'master' into daniel/threepidinvites 9 years ago
Daniel Wagner-Hall 6596802ed7 Merge branch 'newlines' into daniel/threepidinvites-2 9 years ago
Daniel Wagner-Hall 6a56c8a965 Add trailing newline 9 years ago
Daniel Wagner-Hall a548148563 Invite doesn't accept room aliases 9 years ago
Daniel Wagner-Hall 2797fac3aa Swagger /room/{roomId}/invite
This is a transcription of the current spec, with nothing new or
controversial in it.
9 years ago
Daniel Wagner-Hall 1b591a023e Monospace room_id 9 years ago
Daniel Wagner-Hall 04b2b2588f Fix up formatting and typos 9 years ago
Daniel Wagner-Hall 1feb9565e4 Use other-way-around alias format 9 years ago
Daniel Wagner-Hall 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.
9 years ago
Mark Haines c74c1ab098 SPEC-216: Add rooms that have been left to initial sync 9 years ago
Kegan Dougal e10859a887 Replace presence API with new template. 9 years ago
Kegan Dougal 334e10468d Add presence swagger and template. 9 years ago
Kegan Dougal 876a3d2bbc Add package.json 9 years ago
Kegan Dougal 3d70404b94 Update swagger validator to support directories.
This will be used with Jenkins.
9 years ago
Kegan Dougal 0275c2ffa0 Add sync API yaml. Add template for sync_http_api. 9 years ago
Kegan Dougal 8a676a2b9d Add sortFn for profile HTTP API. Add combined profile HTTP API. 9 years ago
Kegan Dougal f6c98f41e9 Use table subsections for param locations instead of an extra column. 9 years ago
Kegan Dougal ba6ce16509 Modify how descriptions are shown. Add profile API descriptions. 9 years ago
Kegan Dougal 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.
9 years ago
Kegan Dougal 5795e1ceda Add profile API examples and extract examples for template usage. 9 years ago
Kegan Dougal fe7ffafc15 Factor out json schema object processing since swagger uses it too. Hook swagger up. 9 years ago
Kegan Dougal d090389d01 Start pre-processing swagger APIs before passing to sections. 9 years ago
Kegan Dougal 99dfe64d5c Add rate-limiting on APIs which rate limit. More descriptions. 9 years ago
Kegan Dougal 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.
9 years ago
Kegan Dougal aeaa43811c Add security definitions for directory API. 9 years ago
Kegan Dougal 870d1b8944 Add Swagger 2 directory API. 9 years ago
Kegan Dougal caa84c1dc1 Add Swagger 2 docs for content repo. Add Swagger 2 CLI validator. 9 years ago
Kegan Dougal 838af288c9 Test swagger commit 9 years ago
Kegsay 5cb656fba7 Minor swagger HTML tweaks 9 years ago
Kegan Dougal c4056bec1b Shuffle around structure of matrix-doc and add a README. 9 years ago