Commit Graph

170 Commits (1e3f5683c8603acababbdbf87b9e6c041307c666)

Author SHA1 Message Date
Richard van der Hoff b0ea6038c6 Move jekyll back out of matrix-doc again
Having the jekyll assets here is a mistake, because they need to be versioned
separately to the spec: we keep old versions of the spec, but they sometimes
need to be restyled to match the latest website.
7 years ago
Richard van der Hoff 8a66b1a68b Build the spec as part of the build 7 years ago
Richard van der Hoff 0af06291fe Hardcode client major version r0 7 years ago
Richard van der Hoff 986e51cf35 Gendoc: allow overriding the dest dir 7 years ago
Richard van der Hoff 9d2a93ad7b Run jekyll as part of the matrix-doc build
- this saves us having to run it manually on the web server.
7 years ago
Richard van der Hoff 934dd4754c swagger-http-server: fix port param
it needs to be an int, not a list
7 years ago
Richard van der Hoff 2ec43a5948 Add continuserv index
Oops, forgot this when adding support for the API docs to continuserv in
bfb65d8.
8 years ago
Richard van der Hoff d41438605d Use matrix.org for swagger UI
In the swagger UI, default to matrix.org rather than localhost, to make the UI
more useful.
8 years ago
Richard van der Hoff bfb65d8ceb Serve the API docs with continuserv 8 years ago
Richard van der Hoff 1320a86cbe Serve the api docs from the speculator
There are a few parts to this:

* when we generate the spec for a particular git sha, also run the script which
  turns our yaml api descriptions into a swagger json file.

* tweak serveSpec to add another header when serving the generated json.

* add a link to the generated index which will (via js hackery) redirect to our
  hosted swagger UI at http://matrix.org/docs/api/client-server, with a "url"
  query-param pointing at the generated json.

Also, factor makeTempDir out of gitClone, so that we can give clearer log lines.
8 years ago
Richard van der Hoff 459f4b953d swagger-http-server: add a --port argument 8 years ago
Oddvar Lovaas 1ea836bb1b Remove howtos from build script 8 years ago
Benjamin Saunders 33d80408e0 Add a nix-shell environment suitable for building
This enables easy execution of scripts/*.py by Nix users.

Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
Richard van der Hoff 49cd65dd58 Add a license to the spec
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
8 years ago
Stas Rudakou b6c41727c5 Add PyYAML to scripts/README.md
PyYAML is a 3rd-party package used by `gendoc.py`.
8 years ago
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.
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
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
Richard van der Hoff a8eed29e9f gendoc: Allow multiple targets 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 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 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
Richard van der Hoff d6c1d1343b Continuserv: Reduce number of watches
rather than trying to watch half the filesystem, be a bit more conservative in
what we put watches on. This means that we don't end up dying with "No space on
device" (thanks for that, Linux.)
8 years ago
Daniel Wagner-Hall 072d285153 speculator: Allow access token to be specified 9 years ago
Richard van der Hoff 1f6c4d5bb2 Speed up gendoc.py by only running build.py once 9 years ago
Daniel Wagner-Hall aaeaa1dd98 Detect major version in presence of patch release 9 years ago
Daniel Wagner-Hall ad7874a730 Use site-relative stylesheet 9 years ago
Daniel Wagner-Hall 60127de1e3 Take list of files to edit as args 9 years ago
Daniel Wagner-Hall a9b4f6fef0 Add missing _ to paths 9 years ago
Daniel Wagner-Hall db5cad4711 Remove accidentally committed change 9 years ago
Daniel Wagner-Hall 99b8a066c8 Make dump-swagger work from all directories 9 years ago
Daniel Wagner-Hall 1f5b6271f2 Generate swagger-ui output for client-server API
Depends on:
https://github.com/matrix-org/matrix-doc/pull/212
https://github.com/matrix-org/matrix-doc/pull/208
https://github.com/matrix-org/matrix-doc/pull/207
for the actual rendered output to not throw javascript errors at runtime.
9 years ago
Richard van der Hoff d1d3d27e2f Merge pull request #216 from matrix-org/rav/fix_speculator_redirects
Add a host and scheme to Location headers in redirects
9 years ago
Richard van der Hoff f31a053995 Add a host and scheme to Location headers in redirects
Our apache reverse-proxy can't correctly rewrite relative Location headers, so
add the Host from the request into the Location.
9 years ago
Matthew Hodgson 78e04d662e add moi :( 9 years ago
Richard van der Hoff 1b7548d460 Make the speculator serve the spec from drafts branches. 9 years ago
Daniel Wagner-Hall 2f3a00fe34 Consistently spell homeserver as homeserver 9 years ago
Daniel Wagner-Hall 1ce3357927 continuserv: serve multiple paths 9 years ago
Daniel Wagner-Hall 97fd1fdd62 Embed client and server release numbers
Note that this also removes the changelog - I'm going to re-add the
changelog differently soon.
9 years ago
Daniel Wagner-Hall ebed3b60bd Add trailing slashes to links 9 years ago
Daniel Wagner-Hall a4668c1d8c Fix typo 9 years ago
Daniel Wagner-Hall c4eaf7458f 302 to spec/head/index.html rather than serving it on /spec/head
Otherwise relative links are broken
9 years ago
Daniel Wagner-Hall 6c66bfc755 Flatten out v1 and v2_alpha directories
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
9 years ago
Daniel Wagner-Hall e401d3e262 Merge pull request #184 from matrix-org/daniel/splitspec
Split spec into page-per-section
9 years ago
Daniel Wagner-Hall 30ed918633 speculator: Allow spec viewing for multi-page spec 9 years ago
Daniel Wagner-Hall e171acf01f Split spec into page-per-section 9 years ago
Daniel Wagner-Hall f0c99a6925 Generate API docs from swagger 9 years ago