Commit Graph

336 Commits (a896729ac2ec68b794cbf8ee3b8e29e3ccfb6078)

Author SHA1 Message Date
Richard van der Hoff 4e90b32348 Set the encoding to UTF-8 on all file I/O
Hopefully this will resolve issues with building the spec on systems where the
default encoding is somthing other than UTF-8.
6 years ago
Ben Parsons f1ae872857 light zebra striping for tables 6 years ago
Ben Parsons 9e1d6d7490 sanitise caption handling 6 years ago
Travis Ralston b2092922e8 Don't define a variable for the appservice major version 6 years ago
Travis Ralston a5c3924492 Merge remote matrix-org/master 6 years ago
Travis Ralston c7a228bf7b Don't make the major version a variable
We are likely to want to maintain v1 when we release a v2, so we'll avoid a variable for now.
6 years ago
Travis Ralston e7a69a6a6d Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep 6 years ago
Travis Ralston 2ab2f91088 Merge remote-tracking branch 'matrix-org/master' into travis/releases/push-gateway/r0.1.0 6 years ago
Ben Parsons 380a53ecba adjust caption -> smaller, left align 6 years ago
Ben Parsons 989b50a1a0 remove debug string 6 years ago
Ben Parsons 6e0fe70500 make spec tables prettier 6 years ago
Travis Ralston b402608b41 Don't reference the major version for the push gateway specification
If we ever have a v2 endpoint for the push gateway, we'd likely spec it alongside the v1 stuff, updating applicable references elsewhere.
6 years ago
Travis Ralston 4278a9a516 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/fix-events 6 years ago
Travis Ralston fa96d8629b Prepare the appservice spec for an r0 release
This puts the scaffolding in place for an r0 release to happen, such as the changelog and version variables.
6 years ago
Travis Ralston e9e93b0eec Move `invite_room_state` to the correct place in the client-server API
Fixes https://github.com/matrix-org/matrix-doc/issues/1350
6 years ago
Travis Ralston 0f28f83270 Fix client-server event schemas: remove `age`, dedupe fields
This commit adds support for event schema examples to have references to help reduce the chance of fields being forgotten. This also helps reduce duplication of fields, allowing for a more consistent spec that uses the same values everywhere.

This also removes both `unsigned` and `age` from the examples as per:
* https://github.com/matrix-org/matrix-doc/issues/1524
* https://github.com/matrix-org/matrix-doc/issues/630

Finally, this replaces "localhost" in the examples with an example domain. This is really just a nitpick thing on my part where seeing a "real world" domain is preferred. 

Fixes https://github.com/matrix-org/matrix-doc/issues/1524
Fixes https://github.com/matrix-org/matrix-doc/issues/630
Step towards https://github.com/matrix-org/matrix-doc/issues/1530
6 years ago
Travis Ralston d370a2c6fd Prepare the identity service and server-server APIs for r0
* Create the changelog scaffolding
* Set up the variables for versioning
6 years ago
Travis Ralston 750d4f9fda Rename the presence EDU files to be accurate to their types; Misc cleanup of titles 6 years ago
Travis Ralston a53fa9300d Merge remote-tracking branch 'matrix-org/master' into travis/s2s/presence 6 years ago
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 6 years ago
Ben Parsons 0c1ba33eba include proposals.py in matrix-doc CI 6 years ago
Ben Parsons ee98082a60 update MSC1270 6 years ago
Ben Parsons cb00fc35ab git checkout master 6 years ago
Ben Parsons d1c27349b2 Merge branch 'master' of https://github.com/matrix-org/matrix-doc 6 years ago
Richard van der Hoff 419bf1e52c Fix continuserv instructions
As per f04b17f1c9

Also dedup continuserv readme
6 years ago
Ben Parsons 7a82a5d427 correct proposals.py 6 years ago
Ben Parsons 34090b24c4 prepare proposals.py for CI 6 years ago
Ben Parsons 663e1a5ebe Update some text 6 years ago
Ben Parsons 73b28612ec updates from feedback on pull 6 years ago
Ben Parsons 4d59abebf0 handle PR links from GitHub 6 years ago
Ben Parsons d338f18927 handle EOF gracefully when searching for Authors and PRs 6 years ago
Ben Parsons f1cc26dfd7 sort output by Created date per-table 6 years ago
Ben Parsons b8f38b21a7 update introductory text 6 years ago
Ben Parsons e87f1f2619 include PRs in tables 6 years ago
Ben Parsons 3b4e56c4e0 handle dd/mm/yyyy and yyyy-mm-dd dates in text 6 years ago
Ben Parsons 3b84de383c cleanup and include all content 6 years ago
Ben Parsons cbdd33a5f5 single authors and shepherds link correctly 6 years ago
Ben Parsons 73b7faddd4 handle multiple Google Docs 6 years ago
Ben Parsons 866b0b6348 I mostly play with ascii art 6 years ago
Ben Parsons dc2b53318b prettify ID column 6 years ago
Ben Parsons a78f7b38e9 generator is now usable 6 years ago
Ben Parsons c58dc59ffe separate tables by label 6 years ago
Ben Parsons 1f7fbefd53 start using a table 6 years ago
Ben Parsons e18aa30fd2 start generating new proposals page 6 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.
6 years ago
Richard van der Hoff 8e97ec8bad make the speculator work for rick 6 years ago
Richard van der Hoff 9150ba0dce Improve error output from failing to parse examples 6 years ago