wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
1623 commits 4 branches 0 tags 17 MiB
Commit graph

1623 commits

This branch
This branch
All branches
Author SHA1 Message Date
Richard van der Hoff
8b61dab1c6 gendoc.py: add --list_targets arg 
I want to be able to run all of the targets except one from matrix-doc, so make
a way to list the targets.
 2016-05-09 12:12:50 +01:00
Richard van der Hoff
69c2eb7edb Merge pull request #333 from matrix-org/rav/back_to_r0.1.0 
Next release will be 0.1.0, not 1.0.0
 2016-05-09 11:51:14 +01:00
Richard van der Hoff
590c55b760 Next release will be 0.1.0, not 1.0.0 
Since synapse is already doing the new behavior on r0 endpoints, and nobody
wants to support the old behaviour, we're defining the new behaviour as r0.1.
 2016-05-09 11:07:15 +01:00
Richard van der Hoff
8f4d7c95df Include '..' lines in changelogs 
Not all lines starting with '..' are comments, and even if they are comments,
they might as well go into the generated spec ReST.
 2016-05-09 11:05:28 +01:00
Richard van der Hoff
86a81b0450 Fix schema for /logout 
'properties' is a map, not a list
 2016-05-08 22:34:17 +01:00
Richard van der Hoff
e7e9f5fa46 Document the /logout api 
We have one, and it's useful, so we really ought to document it
 2016-05-08 22:26:49 +01:00
Richard van der Hoff
2e446594a1 Merge pull request #328 from matrix-org/rav/auth_api_docs 
Tidy up the client-authentication spec
 2016-05-07 17:47:25 +01:00
Oddvar Lovaas
d52377274f adding vector mobile clients 2016-05-06 18:16:59 +01:00
Richard van der Hoff
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
 2016-05-06 17:28:35 +01:00
Richard van der Hoff
2093a6bac9 Merge pull request #332 from matrix-org/rav/update_login_api 
Update the /login API spec
 2016-05-06 17:11:30 +01:00
Richard van der Hoff
2cbebbe506 Merge pull request #331 from matrix-org/rav/doc_interactive_api_params 
Document the user-interactive api params
 2016-05-06 17:11:19 +01:00
Richard van der Hoff
959f1ff09f Update the /login API spec 
Note that /login can be used with 3pid creds
 2016-05-06 16:58:04 +01:00
Richard van der Hoff
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
 2016-05-06 16:47:49 +01:00
Richard van der Hoff
0cdc2da5bf Merge pull request #330 from matrix-org/rav/improve_examples 
Improve API examples in the spec
 2016-05-06 16:37:56 +01:00
Richard van der Hoff
167b84cc7f Another go at formatting examples 
Let's try to avoid parsing the JSON, as it will reorder the examples.
 2016-05-06 16:30:07 +01:00
Richard van der Hoff
45199d0edc Attempt to parse examples as json 
... because some of them are, and we don't want to double-escape them.
 2016-05-06 16:05:05 +01:00
Richard van der Hoff
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
 2016-05-06 15:42:31 +01:00
Richard van der Hoff
2d28e5abce Fix basePath on /redact API doc 2016-05-06 12:39:37 +01:00
Richard van der Hoff
d1fd9de10e Merge pull request #329 from matrix-org/rav/basepath_in_swagger 
Include the basePath in the path in swagger output
 2016-05-06 12:38:40 +01:00
Richard van der Hoff
f46a2a7f2b Include the basePath in the path in swagger output 
This fixes both SPEC-393, and ORG-52.
 2016-05-06 12:35:27 +01:00
Oddvar Lovaas
85ad53ae70 encourage contributions! 2016-05-06 11:53:44 +01:00
Oddvar Lovaas
771b21a316 add new guides to guide page 2016-05-06 11:43:36 +01:00
Richard van der Hoff
b0284f0c7e Merge pull request #327 from matrix-org/rav/no_sort_api 
Don't sort the HTTP APIs
 2016-05-06 11:04:37 +01:00
Richard van der Hoff
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?
 2016-05-06 11:01:03 +01:00
Richard van der Hoff
5cc9066159 Add git versions to other parts of the spec 2016-05-06 09:49:26 +01:00
Richard van der Hoff
0e4a4e1e44 Merge pull request #326 from matrix-org/rav/more_spec_versioning 
Put each bit of spec in its own directory
 2016-05-06 08:43:41 +01:00
Richard van der Hoff
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)
 2016-05-05 18:46:29 +01:00
Richard van der Hoff
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.
 2016-05-05 18:26:17 +01:00
Oddvar Lovaas
1f53be4d59 Merge pull request #325 from matrix-org/oddvar/new-guides 
add these to jekyll
 2016-05-05 17:45:38 +01:00
Oddvar Lovaas
cde9134467 add these to jekyll 2016-05-05 17:37:32 +01:00
Richard van der Hoff
a8eed29e9f gendoc: Allow multiple targets 2016-05-05 16:49:10 +01:00
Richard van der Hoff
a482cda8a8 Merge pull request #324 from matrix-org/rav/spec_versioning 
Move the 'old versions' links into the client-server API spec
 2016-05-05 16:38:21 +01:00
Richard van der Hoff
8f304f3b3e C-S API will be released as r1.0.0, not r0.1.0 2016-05-05 15:34:52 +01:00
Richard van der Hoff
351bbee016 Remove changelog from index.rst 
... since it's explicitly unversioned.
 2016-05-05 15:23:21 +01:00
Richard van der Hoff
7d20d2d903 Add old-version links to C-S API 2016-05-05 15:22:39 +01:00
Richard van der Hoff
1e234ebb75 Merge pull request #323 from matrix-org/rav/clarify_versioning 
Attempt to clarify the spec versioning. Again.
 2016-05-05 15:22:18 +01:00
Richard van der Hoff
5b010de2b3 Fix typo 2016-05-05 15:15:39 +01:00
Richard van der Hoff
e68193d2e0 Attempt to clarify the spec versioning. Again. 2016-05-05 15:03:04 +01:00
Richard van der Hoff
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
 2016-05-05 14:17:51 +01:00
Richard van der Hoff
663fbf2323 Add link to device-specific push rules branch 2016-05-05 14:16:35 +01:00
Matthew Hodgson
17b8fccd4c rephrase intro 2016-05-05 14:00:53 +01:00
Richard van der Hoff
5a50db2eac Update the changelog in preparation for releasing CS spec 0.1.0 2016-05-05 11:52:47 +01:00
Richard van der Hoff
df0e070146 Merge pull request #321 from matrix-org/rav/fix_eventschema_readme 
Update eventschema readme
 2016-05-05 11:41:38 +01:00
Richard van der Hoff
2e9212af8a Fix typo in m.room.member schema 
remove spurious SHOULD
 2016-05-05 11:07:37 +01:00
Richard van der Hoff
a8eb72e7a1 Fix changelog generation 
Gendoc was adding extra newlines to the changelog RST, which messed it all up.
 2016-05-05 11:06:56 +01:00
Richard van der Hoff
4bc78633a5 We don't support z-schema or other JSON tools for now 2016-05-05 10:50:03 +01:00
Richard van der Hoff
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
 2016-05-04 18:33:52 +01:00
Richard van der Hoff
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
 2016-05-04 14:55:43 +01:00
Richard van der Hoff
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
Richard van der Hoff
986f5df82e Merge pull request #319 from matrix-org/rav/swagger_refs 
Improve handling of $ref in swagger files
 2016-05-04 14:38:38 +01:00