Commit Graph

367 Commits (b873ba984c4b3abf227feefb334f7063d5a45f20)

Author SHA1 Message Date
Travis Ralston ba51d5960e r0.1.0 release of the Push Gateway specification
Because this is the first release, it has several moving parts to it:
* The version variables have been defined.
* The towncrier changelog has been prepared for future modifications.
* The templating has been updated to better support future versions of the specification.
* A release process document has been created.
6 years ago
Kitsune Ral 9be78f3aa7 Better support enums when they come among oneOf types 6 years ago
Kitsune Ral 88d97b06ae Support oneOf 6 years ago
Travis Ralston 05a2427c73 Document how presence EDUs work between servers
It's worth noting that Synapse does not make use of the `poll` or `unpoll` fields, and therefore the wording has been updated to permit servers to reject users. In the case of synapse, it would automatically reject everyone in the list by nature of ignoring it.
6 years ago
Travis Ralston 0f8954d839
Merge pull request #1463 from turt2live/travis/s2s/pdus-and-edus
Improve documentation around EDUs and PDUs
6 years ago
Travis Ralston db6d466fa1 Go one level deep when finding definitions
This is useful for when we start defining event schemas. This also has a sanity check for ensuring the directory exists, allowing the IS and push API paths to be uncommented.
6 years ago
Travis Ralston 96f5510266 Ensure the example is always set to something 6 years ago
Travis Ralston ea307b5bdb Support rendering schema definitions in the spec 6 years ago
Ben Parsons 1d019c3757
Merge pull request #1340 from matrix-org/benparsons/prdefence
expect "#<pull-number>" or "/pull/<pull-number>" in PRs field
6 years ago
Ben Parsons d7919b6989 also scrape PRs when the full URL is pasted 6 years ago
Travis Ralston bc3e45d642
Merge pull request #1358 from uhoreg/ignore-emacs-tmp
ignore emacs temporary files
6 years ago
Travis Ralston 4f24d2101f Only get issues that are proposals when finding proposals
Otherwise we end up with not-proposals showing up in the list.
6 years ago
Travis Ralston dcc4b0bfbc Remove Travis CI configuration
We're using Circle CI for testing a bunch of the spec, and so far it has the advantage of being faster. Also, it's not named the same as me.

We can also remove the Travis CI specific check in generate-matrix-org-assets because Circle CI doesn't touch this.
6 years ago
Travis Ralston acf9632afc Enlist the examples 6 years ago
Travis Ralston 9fa838d3e8 Improve type naming 6 years ago
Travis Ralston 5ade15534d Remove extra branch in example generation 6 years ago
Travis Ralston 042772aaf5 Make nested titles better 6 years ago
Travis Ralston cb4fcd1d09 Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger 6 years ago
Travis Ralston a4e5a461f9 Improve handing of lists appearing in items 6 years ago
Travis Ralston 2dae0c9c49 use python3 in dump-swagger.py 6 years ago
Travis Ralston e226b60c7f Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger 6 years ago
Travis Ralston 3ff1b0ddea
Merge pull request #1389 from turt2live/travis/towncrier
Use Towncrier to generate the unstable changelog
6 years ago
Travis Ralston 98c607bff5 Advertise python 3.4 support and use that in Travis CI
We also don't need to update virtualenv, or use python3.5 specific
packages.
6 years ago
Travis Ralston cfac4a1ab3 Use towncrier 18.6.0 final 6 years ago
Travis Ralston e5da1e1741 Improve upon the transaction schema and examples
Reduces data duplication and makes the objects more reusable for other areas of the spec
6 years ago
Travis Ralston 8a4ba8c5ca Use Popen rather than run() 6 years ago
Travis Ralston af7460088f Use six for url quoting 6 years ago
Travis Ralston 374ec00046 Convert things that mention "Transaction" to swagger
There's two kinds of transactions currently: one with EDUs and one without. The one with EDUs is only used on /send, however the schema is still somewhat worth splitting out for simplicity.

The examples are brought apart to make them slightly more reusable for when they get dumped into the relevant sections of the spec (see TODO in server_server_api.rst)

Further, the Transactions stuff introduces tuples to the spec. The units.py has been updated to support this.
6 years ago
Travis Ralston a8461e647f Improve the error handling for towncrier
The changelog shows up via stdout, everything else via stderr. We dump as much information as we can into the changelog to make debugging errors easier.
6 years ago
Travis Ralston 905ef6dadd Have the towncrier generator complain if the output looks wrong 6 years ago
Travis Ralston ebc7db12fb Remove extraneous list casting 6 years ago
Travis Ralston 9e0fafbcd4 Remove debugging line 6 years ago
Travis Ralston 3a9cfd490f
Improve pagination handling in proposals.py
Previously if multiple pages were returned then the script would lose the results. 

A check to ensure the response is an array was also added. This helps avoid somewhat cryptic errors when iterating over non-lists (eg: error messages, bad output, etc)
6 years ago
Travis Ralston 550f95570b Fix regex for some versions of python 6 years ago
Travis Ralston 7ada960206 Fix the Travis CI build to work on 3.5 6 years ago
Travis Ralston 08f6912825 Ask Travis to install 3.5 explicitly 6 years ago
Travis Ralston a4f8e0807a Print the python version being used in the CI build. 6 years ago
Travis Ralston 63b926a4aa Make Travis CI use python 3 6 years ago
Travis Ralston c2f85788de Add documentation about how to add to the changelog 6 years ago
Travis Ralston 9277e4c52d Add initial towncrier support 6 years ago
Travis Ralston f54d5a4039 Convert build scripts to python 3 6 years ago
Travis Ralston 1722734a51
Merge pull request #1364 from turt2live/travis/server-name-join
Document the server_name query parameter on /join/{roomIdOrAlias}
6 years ago
Richard van der Hoff f9a0a49e96 Add a bunch more people to the speculator trusted list 6 years ago
Travis Ralston 4485b2f025
Merge branch 'master' into travis/server-name-join 6 years ago
Travis Ralston 8bd1fe9908
Merge pull request #1357 from turt2live/travis/fix-windows
Use filepath.To/FromSlash instead of manually replacing slashes
6 years ago
Matthew Hodgson d02e9b875b
Merge pull request #1355 from matrix-org/benpa/travisci-ignore-proposals
don't run proposals.py step if in TravisCI environment
6 years ago
Travis Ralston cbbdcbcf01 Show arrays in the query string as "[type]" rather than "array"
Otherwise the question "array of what?" is raised.
6 years ago
Travis Ralston aac7b848f7 Add uhoreg and myself as trusted speculator people 6 years ago
Hubert Chathi a2e0d0382c ignore emacs temporary files
and fix ignoring of dotfiles
6 years ago
Travis Ralston 85e1962f9c Use filepath.To/FromSlash instead of manually replacing slashes
see https://github.com/matrix-org/matrix-doc/pull/1356#discussion_r199897557
6 years ago
Travis Ralston eb21a71b70 Make the builder happier with Windows environments
There's two main issues with Windows environments:
* Slashes
* Windows still notifies about some directories we've ignored, therefore we need to filter them too

It's not super pretty, but it does work.
6 years ago
Ben Parsons 5803c9cace don't run proposals.py step if in TravisCI environment 6 years ago
Ben Parsons e52d94bea9 ignore malformed PR items 6 years ago
user 5ab5fe08d1 Small grammatical and stylistic fixes 7 years ago
Ben Parsons 0c1ba33eba include proposals.py in matrix-doc CI 7 years ago
Ben Parsons ee98082a60 update MSC1270 7 years ago
Ben Parsons cb00fc35ab git checkout master 7 years ago
Ben Parsons d1c27349b2 Merge branch 'master' of https://github.com/matrix-org/matrix-doc 7 years ago
Richard van der Hoff 419bf1e52c Fix continuserv instructions
As per f04b17f1c9

Also dedup continuserv readme
7 years ago
Ben Parsons 7a82a5d427 correct proposals.py 7 years ago
Ben Parsons 34090b24c4 prepare proposals.py for CI 7 years ago
Ben Parsons 663e1a5ebe Update some text 7 years ago
Ben Parsons 73b28612ec updates from feedback on pull 7 years ago
Ben Parsons 4d59abebf0 handle PR links from GitHub 7 years ago
Ben Parsons d338f18927 handle EOF gracefully when searching for Authors and PRs 7 years ago
Ben Parsons f1cc26dfd7 sort output by Created date per-table 7 years ago
Ben Parsons b8f38b21a7 update introductory text 7 years ago
Ben Parsons e87f1f2619 include PRs in tables 7 years ago
Ben Parsons 3b4e56c4e0 handle dd/mm/yyyy and yyyy-mm-dd dates in text 7 years ago
Ben Parsons 3b84de383c cleanup and include all content 7 years ago
Ben Parsons cbdd33a5f5 single authors and shepherds link correctly 7 years ago
Ben Parsons 73b7faddd4 handle multiple Google Docs 7 years ago
Ben Parsons 866b0b6348 I mostly play with ascii art 7 years ago
Ben Parsons dc2b53318b prettify ID column 7 years ago
Ben Parsons a78f7b38e9 generator is now usable 7 years ago
Ben Parsons c58dc59ffe separate tables by label 7 years ago
Ben Parsons 1f7fbefd53 start using a table 7 years ago
Ben Parsons e18aa30fd2 start generating new proposals page 7 years ago
Richard van der Hoff f04b17f1c9 Fix path to fsnotify
Apparently this should be referred to as gopkg.in/fsnotify/fsnotify.v1. I'm not
sure what has changed to stop the old format working.
7 years ago
Richard van der Hoff 8e97ec8bad make the speculator work for rick 7 years ago
Richard van der Hoff 9150ba0dce Improve error output from failing to parse examples 7 years ago
Richard van der Hoff a36bd1a6d2 Make build fail if gendoc fails
(cf https://github.com/matrix-org/matrix-doc/issues/1146)
7 years ago
Richard van der Hoff 87d90ab58a gendoc: improve title line matching
This makes it possible to include tables etc without the script trying to turn
them into titles.
7 years ago
Maxime Dor 1045bc721d Document federation version endpoint 7 years ago
Richard van der Hoff 427e0bb83b make jenkins and travis use a common script 7 years ago
Richard van der Hoff 202a265d85 Config for travis-ci 7 years ago
Richard van der Hoff 0cbf533625 Use petstore for continuserv swagger docs
Matrix.org's swagger browser is behind https, which means it can't read the
swagger from a continuserv on http. Use the petstore instead.
7 years ago
Richard van der Hoff a38d4fc68e Move templating into scripts dir
There's no real need for this to be at the top level.
7 years ago
Richard van der Hoff e7772af5c3 Supporting-docs now in matrix.org repo. 7 years ago
Richard van der Hoff cc6b16b63c Generate the swagger for export
We may as well generate the unstable version of the C-S swagger.
7 years ago
Richard van der Hoff d6f892f894 continuserv, speculator: update dump-swagger call
dump-swagger now expects -o before its output path
7 years ago
Richard van der Hoff 56c3e5a627 README.rst: Add notes on how to build the spec 7 years ago
Richard van der Hoff 834a3d78a8 Add a pip requirements file for the scripts 7 years ago
Richard van der Hoff 986c9d99a0 Improve arg parsing in dump-swagger 7 years ago
Richard van der Hoff 0dfff6b190 Simplify dump_swagger
We don't need most of the templating stuff. All we have to do is merge together
the swagger files, and resolve references.
7 years ago
Richard van der Hoff 2454598926 Speculator: include API docs links for branches 7 years ago
Richard van der Hoff 13d3293378 Fix version-extraction regexp
Fixes https://github.com/matrix-org/matrix-doc/issues/982
7 years ago
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
8 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`.
9 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.
9 years ago
Richard van der Hoff f46a2a7f2b Include the basePath in the path in swagger output
This fixes both SPEC-393, and ORG-52.
9 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)
9 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.
9 years ago
Richard van der Hoff a8eed29e9f gendoc: Allow multiple targets 9 years ago
Richard van der Hoff 7138205f31 Update README.md
escape angle-bracket to stop it getting lost in markdown
9 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.
9 years ago
Richard van der Hoff 23c4ffbc1b Add securityDefintions to generated swagger JSON
Also factor out to a common file
9 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
9 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.
9 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.)
9 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
Richard van der Hoff 2aa4773cc1 Make the speculator serve up errors as plain text
... so that they are legible.
9 years ago
Daniel Wagner-Hall ec31c0f518 speculator: allow styling like matrix.org 9 years ago
Daniel Wagner-Hall cc4869e68a Merge pull request #174 from matrix-org/daniel/speculatorhardening
Several improvements to speculator to prepare it for actually being used by the masses, not just us devs
9 years ago