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

1602 commits

This branch
This branch
All branches
Author SHA1 Message Date
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
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
Richard van der Hoff
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.
 2016-05-04 14:24:01 +01:00
Richard van der Hoff
4c46c95d0e Merge pull request #317 from ruma/master 
Improvements to the spec index page
 2016-05-04 10:34:32 +01:00
Jimmy Cuadra
c44d61b3a9 Clarify which documents are generated from scripts. 2016-05-04 02:30:44 -07:00
Jimmy Cuadra
22b542e3f9 Fix grammar in spec index. 2016-05-04 02:27:29 -07:00
Jimmy Cuadra
5b18db9096 Make list of APIs on the index a table. 2016-05-04 01:42:01 -07:00
Jimmy Cuadra
4b27d6a7a4 Reorganize spec index. 2016-05-04 01:42:01 -07:00
Richard van der Hoff
7138205f31 Update README.md 
escape angle-bracket to stop it getting lost in markdown
 2016-05-04 01:08:50 +01:00
Richard van der Hoff
1fe00b1517 Reinstate validator.js 
It turns out that validator.js is used by the jenkins build script to, uh,
validate the docs.

This partially reverts commit affb106014.
 2016-05-04 00:19:46 +01:00
Richard van der Hoff
0546f0917d Replace hacky shell to do matrix styling with hacky perl 
Since the shell just wrapped three invocations of perl, we might as well do
it all in perl.
 2016-05-04 00:01:54 +01:00
Richard van der Hoff
23c4ffbc1b Add securityDefintions to generated swagger JSON 
Also factor out to a common file
 2016-05-03 13:57:16 +01:00
Richard van der Hoff
cf87120d78 Fixes to the API docs 
* fix security data for DELETE /user/{userId}/rooms/{roomId}/tags/{tag}

* fix definition for body of PUT /pushrules/{scope}/{kind}/{ruleId}/actions
 2016-05-03 13:52:11 +01:00
Richard van der Hoff
affb106014 Remove redundant scripts under api/ 
We now use newer swagger, via scripts/dump-swagger.py
 2016-05-03 12:05:52 +01:00
Richard van der Hoff
60f36bf868 Script to serve the generated swagger JSON 
We need custom CORS headers to serve the swagger JSON, so add a script to do it
 2016-05-03 12:04:44 +01:00
Richard van der Hoff
c39d797cce Dump-swagger: take output file name rather than output dir 
Make the argument to dump-swagger.py be the name of the output file rather than
the output dir, and give it a sensible default.

Also, use the absolute path to the output file, so that the output path is
relative to the user's cwd rather than the templating dir.
 2016-05-03 12:03:21 +01:00
Paul Evans
9b93c5f463 Merge pull request #314 from matrix-org/paul/update-howto-for-r0 
Update client-server howto for r0
 2016-04-25 14:20:23 +01:00
Paul "LeoNerd" Evans
8824fe8391 Remove port number from room IDs in pasted examples 2016-04-25 13:55:57 +01:00
Paul "LeoNerd" Evans
b448c96096 Use port 8448 in example URLs 2016-04-25 13:51:10 +01:00
Paul "LeoNerd" Evans
4a565876ee Merge remote-tracking branch 'origin/master' into paul/update-howto-for-r0 2016-04-25 13:50:26 +01:00
Paul Evans
0d2bed7e66 Merge pull request #313 from matrix-org/paul/migrating-from-v1 
Initial hack at migration guide
 2016-04-21 18:56:49 +01:00
Paul "LeoNerd" Evans
a077f8470a Various rewordings from latest review comments 2016-04-21 17:23:04 +01:00
Paul "LeoNerd" Evans
ea6ac3e40f Another rewording of 'state' returned by '/sync' with 'since' parameter 2016-04-20 15:04:23 +01:00