e7e9f5fa46
Document the /logout api
...
We have one, and it's useful, so we really ought to document it
9 years ago
2e446594a1
Merge pull request #328 from matrix-org/rav/auth_api_docs
...
Tidy up the client-authentication spec
9 years ago
d52377274f
adding vector mobile clients
9 years ago
3bce28a15c
Clarifications to the 'Client authentication' section
...
* Use the terminology 'login type' everywhere instead of mixing up 'stage type'
and 'login type'
* Don't have a separate 'APIs using the User-Interactive Authentication
mechanism' section, because (a) it doesn't make much sense to organise the
APIs this way, and (b) it was a set of lies anyway.
* Move '/account/password' definition into registration.yaml so that register
and password can share a section in the spec; remove duplicate doc for
/password.
* Write some words on using 3pids for /login
9 years ago
2093a6bac9
Merge pull request #332 from matrix-org/rav/update_login_api
...
Update the /login API spec
9 years ago
2cbebbe506
Merge pull request #331 from matrix-org/rav/doc_interactive_api_params
...
Document the user-interactive api params
9 years ago
959f1ff09f
Update the /login API spec
...
Note that /login can be used with 3pid creds
9 years ago
9efd021f5e
Document the user-interactive api params
...
Document the parameters and responses on /register and /account/password which
are invoved in the user-interactive auth
9 years ago
0cdc2da5bf
Merge pull request #330 from matrix-org/rav/improve_examples
...
Improve API examples in the spec
9 years ago
167b84cc7f
Another go at formatting examples
...
Let's try to avoid parsing the JSON, as it will reorder the examples.
9 years ago
45199d0edc
Attempt to parse examples as json
...
... because some of them are, and we don't want to double-escape them.
9 years ago
6b23598a26
Improve API examples in the spec
...
* Show response codes even if we don't have examples for them
* Walk the objects to build param examples if none are given at the top level
9 years ago
2d28e5abce
Fix basePath on /redact API doc
9 years ago
d1fd9de10e
Merge pull request #329 from matrix-org/rav/basepath_in_swagger
...
Include the basePath in the path in swagger output
9 years ago
f46a2a7f2b
Include the basePath in the path in swagger output
...
This fixes both SPEC-393, and ORG-52.
9 years ago
85ad53ae70
encourage contributions!
9 years ago
771b21a316
add new guides to guide page
9 years ago
b0284f0c7e
Merge pull request #327 from matrix-org/rav/no_sort_api
...
Don't sort the HTTP APIs
9 years ago
695a533e45
Don't sort the HTTP APIs
...
We can order them manually in the YAML, so why would we want a completely
different order in the spec?
9 years ago
5cc9066159
Add git versions to other parts of the spec
9 years ago
0e4a4e1e44
Merge pull request #326 from matrix-org/rav/more_spec_versioning
...
Put each bit of spec in its own directory
9 years ago
8aa0f64665
Update the speculator to understand spec subdirs
...
Fix the speculator so that it doesn't blow up when it finds subdirs in the gen
directory.
(It doesn't handle the html diff very well in the case that the subdirs don't
match, but it's hard to do much about that)
9 years ago
01f8173c84
Put each bit of spec in its own directory
...
I want to change the URLs for the spec sections on the website from
<version>/<section>.html to <section>/<version>.html, to better reflect how we
do the versioning.
This puts each bit of spec in its own directory, updates the index to point to
the right place, and fixes continuserv to deal with directories as well as
files.
This will probably require fixes to the speculator too, but I'll have to come
back to that.
9 years ago
1f53be4d59
Merge pull request #325 from matrix-org/oddvar/new-guides
...
add these to jekyll
9 years ago
cde9134467
add these to jekyll
9 years ago
a8eed29e9f
gendoc: Allow multiple targets
9 years ago
a482cda8a8
Merge pull request #324 from matrix-org/rav/spec_versioning
...
Move the 'old versions' links into the client-server API spec
9 years ago
8f304f3b3e
C-S API will be released as r1.0.0, not r0.1.0
9 years ago
351bbee016
Remove changelog from index.rst
...
... since it's explicitly unversioned.
9 years ago
7d20d2d903
Add old-version links to C-S API
9 years ago
1e234ebb75
Merge pull request #323 from matrix-org/rav/clarify_versioning
...
Attempt to clarify the spec versioning. Again.
9 years ago
5b010de2b3
Fix typo
9 years ago
e68193d2e0
Attempt to clarify the spec versioning. Again.
9 years ago
2111a8b6a0
Merge pull request #322 from matrix-org/rav/prepare_cs_r0.1.0
...
Update the changelog in preparation for releasing CS spec 0.1.0
9 years ago
663fbf2323
Add link to device-specific push rules branch
9 years ago
17b8fccd4c
rephrase intro
9 years ago
5a50db2eac
Update the changelog in preparation for releasing CS spec 0.1.0
9 years ago
df0e070146
Merge pull request #321 from matrix-org/rav/fix_eventschema_readme
...
Update eventschema readme
9 years ago
2e9212af8a
Fix typo in m.room.member schema
...
remove spurious SHOULD
9 years ago
a8eb72e7a1
Fix changelog generation
...
Gendoc was adding extra newlines to the changelog RST, which messed it all up.
9 years ago
4bc78633a5
We don't support z-schema or other JSON tools for now
9 years ago
be09cd859d
Fix errors when running build.py with default args
...
Fixes ugly errors when build.py was run (a) with no --substitutions at all, and
(b) without the expected substitutions
9 years ago
432c78f3b5
Fix the swagger for /search so that it works without preprocessing
...
Makes the /search swagger work when it is imported directly into the swagger-UI
without preprocessing by dump_swagger
9 years ago
5383754a40
Access event-schemas via a symlink
...
Swagger gets a bit confused about $refs via '../..', so use a symlink to make
everything nicely relative.
9 years ago
986f5df82e
Merge pull request #319 from matrix-org/rav/swagger_refs
...
Improve handling of $ref in swagger files
9 years ago
262c9ea113
Improve handling of $ref in swagger files
...
It turns out that swagger merges $refed attributes with those defined inline,
so do the same here.
9 years ago
4c46c95d0e
Merge pull request #317 from ruma/master
...
Improvements to the spec index page
9 years ago
c44d61b3a9
Clarify which documents are generated from scripts.
9 years ago
22b542e3f9
Fix grammar in spec index.
9 years ago
5b18db9096
Make list of APIs on the index a table.
9 years ago
Richard van der Hoff