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.
2018-08-30 17:18:07 +01:00
f1ae872857
light zebra striping for tables
2018-08-30 17:16:45 +01:00
9e1d6d7490
sanitise caption handling
2018-08-30 17:01:27 +01:00
b2092922e8
Don't define a variable for the appservice major version
2018-08-29 21:51:26 -06:00
a5c3924492
Merge remote matrix-org/master
2018-08-29 21:28:24 -06:00
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.
2018-08-29 19:32:52 -06:00
e7a69a6a6d
Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep
2018-08-29 19:29:42 -06:00
2ab2f91088
Merge remote-tracking branch 'matrix-org/master' into travis/releases/push-gateway/r0.1.0
2018-08-29 17:54:34 -06:00
380a53ecba
adjust caption -> smaller, left align
2018-08-29 17:18:37 +01:00
989b50a1a0
remove debug string
2018-08-29 16:40:26 +01:00
6e0fe70500
make spec tables prettier
2018-08-29 16:38:59 +01:00
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.
2018-08-28 14:40:14 -06:00
4278a9a516
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/fix-events
2018-08-27 19:17:37 -06:00
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.
2018-08-27 18:04:08 -06:00
e9e93b0eec
Move `invite_room_state` to the correct place in the client-server API
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1350
2018-08-26 20:51:39 -06:00
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
2018-08-24 18:04:51 -06:00
d370a2c6fd
Prepare the identity service and server-server APIs for r0
...
* Create the changelog scaffolding
* Set up the variables for versioning
2018-08-24 17:19:25 -06:00
750d4f9fda
Rename the presence EDU files to be accurate to their types; Misc cleanup of titles
2018-08-17 10:53:47 -06:00
a53fa9300d
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/presence
2018-08-17 09:34:16 -06:00
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.
2018-08-16 11:50:18 -06:00
9be78f3aa7
Better support enums when they come among oneOf types
2018-08-12 16:45:35 +09:00
88d97b06ae
Support oneOf
2018-08-12 16:45:33 +09:00
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.
2018-08-08 08:24:09 -06:00
0f8954d839
Merge pull request #1463 from turt2live/travis/s2s/pdus-and-edus
...
Improve documentation around EDUs and PDUs
2018-08-08 08:02:37 -06:00
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.
2018-08-03 19:49:46 -06:00
96f5510266
Ensure the example is always set to something
2018-08-03 12:03:23 -06:00
ea307b5bdb
Support rendering schema definitions in the spec
2018-07-31 13:55:53 -06:00
1d019c3757
Merge pull request #1340 from matrix-org/benparsons/prdefence
...
expect "#<pull-number>" or "/pull/<pull-number>" in PRs field
2018-07-31 15:17:42 +01:00
d7919b6989
also scrape PRs when the full URL is pasted
2018-07-31 15:08:42 +01:00
bc3e45d642
Merge pull request #1358 from uhoreg/ignore-emacs-tmp
...
ignore emacs temporary files
2018-07-30 17:09:08 -06:00
4f24d2101f
Only get issues that are proposals when finding proposals
...
Otherwise we end up with not-proposals showing up in the list.
2018-07-26 09:51:08 -06:00
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.
2018-07-24 14:47:47 -06:00
acf9632afc
Enlist the examples
2018-07-24 10:25:24 -06:00
9fa838d3e8
Improve type naming
2018-07-24 10:17:57 -06:00
5ade15534d
Remove extra branch in example generation
2018-07-24 10:17:39 -06:00
042772aaf5
Make nested titles better
2018-07-24 10:13:23 -06:00
cb4fcd1d09
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger
2018-07-24 09:15:36 -06:00
a4e5a461f9
Improve handing of lists appearing in items
2018-07-24 09:14:31 -06:00
2dae0c9c49
use python3 in dump-swagger.py
2018-07-19 08:54:04 -06:00
e226b60c7f
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger
2018-07-18 10:59:39 -06:00
3ff1b0ddea
Merge pull request #1389 from turt2live/travis/towncrier
...
Use Towncrier to generate the unstable changelog
2018-07-18 08:27:02 -06:00
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.
2018-07-17 10:28:57 -06:00
cfac4a1ab3
Use towncrier 18.6.0 final
2018-07-17 08:48:31 -06:00
e5da1e1741
Improve upon the transaction schema and examples
...
Reduces data duplication and makes the objects more reusable for other areas of the spec
2018-07-12 21:34:52 -06:00
8a4ba8c5ca
Use Popen rather than run()
2018-07-12 10:16:32 -06:00
af7460088f
Use six for url quoting
2018-07-12 10:07:09 -06:00
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.
2018-07-11 16:52:27 -06:00
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.
2018-07-11 08:35:55 -06:00
905ef6dadd
Have the towncrier generator complain if the output looks wrong
2018-07-10 16:57:21 -06:00
ebc7db12fb
Remove extraneous list casting
2018-07-10 16:52:17 -06:00
9e0fafbcd4
Remove debugging line
2018-07-10 15:13:22 -06:00
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)
2018-07-09 23:52:22 -06:00
550f95570b
Fix regex for some versions of python
2018-07-09 15:17:43 -06:00
7ada960206
Fix the Travis CI build to work on 3.5
2018-07-09 14:55:25 -06:00
08f6912825
Ask Travis to install 3.5 explicitly
2018-07-09 12:13:58 -06:00
a4f8e0807a
Print the python version being used in the CI build.
2018-07-09 08:41:20 -06:00
63b926a4aa
Make Travis CI use python 3
2018-07-06 17:19:04 -06:00
c2f85788de
Add documentation about how to add to the changelog
2018-07-06 16:54:14 -06:00
9277e4c52d
Add initial towncrier support
2018-07-06 16:32:27 -06:00
f54d5a4039
Convert build scripts to python 3
2018-07-06 15:21:07 -06:00
1722734a51
Merge pull request #1364 from turt2live/travis/server-name-join
...
Document the server_name query parameter on /join/{roomIdOrAlias}
2018-07-06 07:00:24 -06:00
f9a0a49e96
Add a bunch more people to the speculator trusted list
2018-07-05 20:27:40 +01:00
4485b2f025
Merge branch 'master' into travis/server-name-join
2018-07-05 11:23:13 -06:00
8bd1fe9908
Merge pull request #1357 from turt2live/travis/fix-windows
...
Use filepath.To/FromSlash instead of manually replacing slashes
2018-07-04 08:09:43 -06:00
d02e9b875b
Merge pull request #1355 from matrix-org/benpa/travisci-ignore-proposals
...
don't run proposals.py step if in TravisCI environment
2018-07-04 00:04:25 +01:00
cbbdcbcf01
Show arrays in the query string as "[type]" rather than "array"
...
Otherwise the question "array of what?" is raised.
2018-07-03 15:50:01 -06:00
aac7b848f7
Add uhoreg and myself as trusted speculator people
2018-07-03 13:10:28 -06:00
a2e0d0382c
ignore emacs temporary files
...
and fix ignoring of dotfiles
2018-07-03 14:10:22 -04:00
85e1962f9c
Use filepath.To/FromSlash instead of manually replacing slashes
...
see https://github.com/matrix-org/matrix-doc/pull/1356#discussion_r199897557
2018-07-03 12:07:31 -06:00
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.
2018-07-03 10:49:55 -06:00
5803c9cace
don't run proposals.py step if in TravisCI environment
2018-07-03 15:49:40 +01:00
e52d94bea9
ignore malformed PR items
2018-06-25 15:00:58 +01:00
5ab5fe08d1
Small grammatical and stylistic fixes
2018-06-17 15:49:39 +01:00
0c1ba33eba
include proposals.py in matrix-doc CI
2018-06-07 14:30:50 +01:00
ee98082a60
update MSC1270
2018-06-04 12:12:48 +01:00
cb00fc35ab
git checkout master
2018-05-31 15:54:23 +01:00
d1c27349b2
Merge branch 'master' of https://github.com/matrix-org/matrix-doc
2018-05-31 15:47:34 +01:00
419bf1e52c
Fix continuserv instructions
...
As per f04b17f1c9
2018-05-30 09:45:22 +01:00
7a82a5d427
correct proposals.py
2018-05-29 14:20:48 +01:00
34090b24c4
prepare proposals.py for CI
2018-05-29 14:19:03 +01:00
663e1a5ebe
Update some text
2018-05-18 10:17:54 +01:00
73b28612ec
updates from feedback on pull
2018-05-15 16:07:55 +01:00
4d59abebf0
handle PR links from GitHub
2018-05-15 15:33:39 +01:00
d338f18927
handle EOF gracefully when searching for Authors and PRs
2018-05-15 15:22:03 +01:00
f1cc26dfd7
sort output by Created date per-table
2018-05-15 11:59:34 +01:00
b8f38b21a7
update introductory text
2018-05-14 14:25:12 +01:00
e87f1f2619
include PRs in tables
2018-05-14 11:32:40 +01:00
3b4e56c4e0
handle dd/mm/yyyy and yyyy-mm-dd dates in text
2018-05-14 09:48:54 +01:00
3b84de383c
cleanup and include all content
2018-05-12 10:30:52 +01:00
cbdd33a5f5
single authors and shepherds link correctly
2018-05-11 21:23:06 +01:00
73b7faddd4
handle multiple Google Docs
2018-05-11 20:47:27 +01:00
866b0b6348
I mostly play with ascii art
2018-05-10 16:02:55 +01:00
dc2b53318b
prettify ID column
2018-05-09 11:32:31 +01:00
a78f7b38e9
generator is now usable
2018-05-08 15:35:46 +01:00
c58dc59ffe
separate tables by label
2018-05-08 14:43:06 +01:00
1f7fbefd53
start using a table
2018-05-08 12:17:38 +01:00
e18aa30fd2
start generating new proposals page
2018-05-02 13:47:01 +01:00
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.
2018-03-27 11:27:23 +01:00
8e97ec8bad
make the speculator work for rick
2018-03-14 17:52:10 +00:00
9150ba0dce
Improve error output from failing to parse examples
2018-03-06 11:09:33 +00:00
Richard van der Hoff