Commit Graph

1605 Commits (d1fd9de10e216ea4a55a9e3ec321561bf7520538)
 

Author SHA1 Message Date
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
8 years ago
Richard van der Hoff f46a2a7f2b Include the basePath in the path in swagger output
This fixes both SPEC-393, and ORG-52.
8 years ago
Oddvar Lovaas 85ad53ae70 encourage contributions! 8 years ago
Oddvar Lovaas 771b21a316 add new guides to guide page 8 years ago
Richard van der Hoff b0284f0c7e Merge pull request #327 from matrix-org/rav/no_sort_api
Don't sort the HTTP APIs
8 years ago
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?
8 years ago
Richard van der Hoff 5cc9066159 Add git versions to other parts of the spec 8 years ago
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
8 years ago
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)
8 years ago
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.
8 years ago
Oddvar Lovaas 1f53be4d59 Merge pull request #325 from matrix-org/oddvar/new-guides
add these to jekyll
8 years ago
Oddvar Lovaas cde9134467 add these to jekyll 8 years ago
Richard van der Hoff a8eed29e9f gendoc: Allow multiple targets 8 years ago
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
8 years ago
Richard van der Hoff 8f304f3b3e C-S API will be released as r1.0.0, not r0.1.0 8 years ago
Richard van der Hoff 351bbee016 Remove changelog from index.rst
... since it's explicitly unversioned.
8 years ago
Richard van der Hoff 7d20d2d903 Add old-version links to C-S API 8 years ago
Richard van der Hoff 1e234ebb75 Merge pull request #323 from matrix-org/rav/clarify_versioning
Attempt to clarify the spec versioning. Again.
8 years ago
Richard van der Hoff 5b010de2b3 Fix typo 8 years ago
Richard van der Hoff e68193d2e0 Attempt to clarify the spec versioning. Again. 8 years ago
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
8 years ago
Richard van der Hoff 663fbf2323 Add link to device-specific push rules branch 8 years ago
Matthew Hodgson 17b8fccd4c rephrase intro 8 years ago
Richard van der Hoff 5a50db2eac Update the changelog in preparation for releasing CS spec 0.1.0 8 years ago
Richard van der Hoff df0e070146 Merge pull request #321 from matrix-org/rav/fix_eventschema_readme
Update eventschema readme
8 years ago
Richard van der Hoff 2e9212af8a Fix typo in m.room.member schema
remove spurious SHOULD
8 years ago
Richard van der Hoff a8eb72e7a1 Fix changelog generation
Gendoc was adding extra newlines to the changelog RST, which messed it all up.
8 years ago
Richard van der Hoff 4bc78633a5 We don't support z-schema or other JSON tools for now 8 years ago
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
8 years ago
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
8 years ago
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.
8 years ago
Richard van der Hoff 986f5df82e Merge pull request #319 from matrix-org/rav/swagger_refs
Improve handling of $ref in swagger files
8 years ago
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.
8 years ago
Richard van der Hoff 4c46c95d0e Merge pull request #317 from ruma/master
Improvements to the spec index page
8 years ago
Jimmy Cuadra c44d61b3a9 Clarify which documents are generated from scripts. 8 years ago
Jimmy Cuadra 22b542e3f9 Fix grammar in spec index. 8 years ago
Jimmy Cuadra 5b18db9096 Make list of APIs on the index a table. 8 years ago
Jimmy Cuadra 4b27d6a7a4 Reorganize spec index. 8 years ago
Richard van der Hoff 7138205f31 Update README.md
escape angle-bracket to stop it getting lost in markdown
8 years ago
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.
8 years ago
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.
8 years ago
Richard van der Hoff 23c4ffbc1b Add securityDefintions to generated swagger JSON
Also factor out to a common file
8 years ago
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
8 years ago
Richard van der Hoff affb106014 Remove redundant scripts under api/
We now use newer swagger, via scripts/dump-swagger.py
8 years ago
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
8 years ago
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.
8 years ago
Paul Evans 9b93c5f463 Merge pull request #314 from matrix-org/paul/update-howto-for-r0
Update client-server howto for r0
8 years ago
Paul "LeoNerd" Evans 8824fe8391 Remove port number from room IDs in pasted examples 8 years ago
Paul "LeoNerd" Evans b448c96096 Use port 8448 in example URLs 8 years ago
Paul "LeoNerd" Evans 4a565876ee Merge remote-tracking branch 'origin/master' into paul/update-howto-for-r0 8 years ago