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
4b27d6a7a4
Reorganize spec index.
9 years ago
7138205f31
Update README.md
...
escape angle-bracket to stop it getting lost in markdown
9 years ago
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
9 years ago
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.
9 years ago
23c4ffbc1b
Add securityDefintions to generated swagger JSON
...
Also factor out to a common file
9 years ago
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
9 years ago
affb106014
Remove redundant scripts under api/
...
We now use newer swagger, via scripts/dump-swagger.py
9 years ago
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
9 years ago
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.
9 years ago
9b93c5f463
Merge pull request #314 from matrix-org/paul/update-howto-for-r0
...
Update client-server howto for r0
9 years ago
8824fe8391
Remove port number from room IDs in pasted examples
9 years ago
b448c96096
Use port 8448 in example URLs
9 years ago
4a565876ee
Merge remote-tracking branch 'origin/master' into paul/update-howto-for-r0
9 years ago
0d2bed7e66
Merge pull request #313 from matrix-org/paul/migrating-from-v1
...
Initial hack at migration guide
9 years ago
Richard van der Hoff