374 Commits (7e92964dc5ed070d2adf0dac0a0d0ac9d4888129)

Author	SHA1	Message	Date
Travis Ralston	a3364ff357	Spec SAS verification and the common key verification framework ... Reference implementations: * 94f664e725 * https://github.com/matrix-org/matrix-react-sdk/pull/2461 * https://github.com/matrix-org/matrix-js-sdk/pull/818 * https://github.com/matrix-org/matrix-react-sdk/pull/2596 * https://github.com/matrix-org/matrix-js-sdk/pull/837 Proposals: * [MSC1717](https://github.com/matrix-org/matrix-doc/pull/1717) * [MSC1267](https://github.com/matrix-org/matrix-doc/issues/1267) No alterations to either proposal have been made intentionally here.	6 years ago
Travis Ralston	f3c0c5232f	Add a table to show how changes in membership should be interpreted ... Fixes https://github.com/matrix-org/matrix-doc/issues/876	6 years ago
Travis Ralston	d6d74c4cbe	Switch to using $ instead of # for sub-types ... # is reserved by the swagger validator as a way to include partial content from a JSON object (eg: "#/path" would include {"test": true} from the object {"path":{"test":true}}). Instead of trying to convince the validator that it is wrong, we'll just use a different character. Note that our rendering tools do not care about #-style references to objects. It's still somewhat worth changing the character though.	6 years ago
Travis Ralston	62890d21b2	Fix example Content-Type for /media/upload request ... Fixes https://github.com/matrix-org/matrix-doc/issues/1770	6 years ago
Travis Ralston	5eea4a477f	Add server notices support ... As per [MSC1452](https://github.com/matrix-org/matrix-doc/issues/1452) Fixes https://github.com/matrix-org/matrix-doc/issues/1254 Although MSC1452 focuses on just the warnings part of the server notices, the base for notices has not been established in the spec. This commit adds the needed support to be able to handle notices. No intentional divergences from the proposal are included in this changeset. There are a few additions which are used in practice although not defined in the proposal, such as who is responsible for aesthetics, sending notices, and other misc rules.	6 years ago
Richard van der Hoff	4e9dc2098f	Fix comments which refer to jenkins. (#1981) ... * Fix comments which refer to jenkins. * Spelling Co-Authored-By: turt2live <travpc@gmail.com>	6 years ago
Richard van der Hoff	6cdc8982fa	jenkins is dead, long live buildkite	6 years ago
Travis Ralston	b1689a3036	Misc improvements	6 years ago
Travis Ralston	b42310ab9d	Merge branch 'master' into travis/fix-changelog	6 years ago
Travis Ralston	76946a8a7c	Simplify changelog generation ... We don'e need `{{server_server_changelog_r0.1.0}}` (for example), so don't go through the hassle of generating it. Instead, we'll generate the changelog for the requested versions of each API and put that in place. In the future, we may wish to consider bringing back more complicated variables when/if we start generating released versions of the spec on the fly rather than manually.	6 years ago
Travis Ralston	54ee861b5f	Fix changelog generation for non-default versions ... Currently if you generate a changelog for r0.1.1 of an API, you'd get "No significant changes" which is wrong. You should get a real changelog for the version. This is now handled by generating a "preferred" changelog which acts as the default for version variables in the RST. Using a specific version's changelog is still supported for the rare cases where that is desired.	6 years ago
Travis Ralston	6067a4ad3c	Use the real identity server version in the APIs table	6 years ago
Travis Ralston	6c7eea555a	Merge pull request #1773 from matrix-org/travis/spec/rooms ... Add a room version specification	6 years ago
Travis Ralston	71e6321f4d	Rework how room versions are represented ... Versions are actually on a scale of recommendations, and are expected to be created as needed. The scale presented here (develop/beta/default/recommended/mandatory) is a more wordy version of what was previously discussed/intended for room versions - the labels aren't final and may be changed.	6 years ago
Andrew Morgan	b7b96833d0	Fix sticky headers so they don't hide behind header bar on desktop	6 years ago
Andrew Morgan	f738f671d1	Sticky headers for proposals page	6 years ago
Travis Ralston	ffe577371d	Add a room version specification ... The "Room Specification" (or "Room Version Specification") is the specification that defines which room versions do what and are intended to be documents which speak the truth about how rooms operate under the hood. The approach taken here is a bit different than other specifications. For starters, the specification is versioned in this project instead of relying on the matrix.org repository to track compiled HTML. This is done for a couple reasons, the first being we're still developing the v1 specification while concurrently making a v2 spec and the second being trying to reduce the reliance on matrix.org's repository for specifications. Because the room spec is built into versions, some changes needed to be made. The `targets.yaml` now has a special syntax for indicating what version something is at, and the changelog generator can handle rendering different versions of the same changelog (as parsed from the RST). Some additional work has been put in to the changelog parsing to allow us to reference the v1 room spec as "v1" without having to sacrifice clarity in the changelog headings. Finally, this moves the state resolution algorithms into the versioned spec as a result of MSC1759 (https://github.com/matrix-org/matrix-doc/pull/1759). Note: this does not introduce the concept of versioned schemas (tabs) that I was previously working with. There's currently no use for them, so they are shelved elsewhere.	6 years ago
Richard van der Hoff	a451e007a4	Fix labels in proposals script	6 years ago
Richard van der Hoff	fa0b4f9e13	Make the proposal labels match what happens in practice	6 years ago
Richard van der Hoff	926cfe4f75	Change the labels the proposals list looks for ... This is slightly complicated by the `proposal-wip` label going away, and becoming implicit	6 years ago
Erik Johnston	4271391214	Initial stab at documenting soft fail (#1641)	6 years ago
Matthew Hodgson	1fc6465168	remove archaic port 8448 from matrix.org URL for swagger-ui	6 years ago
Matthew Hodgson	d789564db7	only apply list CSS overrides to section classes	6 years ago
Travis Ralston	7d34995ece	It's actually an "identity server implementing the Identity Service API" ... Also add a note about appservices being special.	6 years ago
Travis Ralston	7ac76fa27c	Actually we're going with "identity server" afterall	6 years ago
Richard van der Hoff	8773b9319b	Merge pull request #1599 from matrix-org/benpa/spec-tables-prettier ... Benpa/spec tables prettier	6 years ago
Travis Ralston	84a2b7f3c0	Merge pull request #1632 from uhoreg/fix_room_member_state_key ... fix handling of multi-line state key descriptions	6 years ago
Ben Parsons	c77b505441	capitali[zs]e path parameters	6 years ago
Ben Parsons	778fe2a47a	css caption size tweak	6 years ago
Ben Parsons	e8afab1fe5	many visual improvements	6 years ago
Travis Ralston	98a445890c	Render a warning if the spec is unstable ... Fixes https://github.com/matrix-org/matrix-doc/issues/1499 This is done by using magic variables in the RST. The magic variables are generated based on the substitutions available, making them available for use at build-time. Magic variables were chosen because it allows people to continue working on the spec and release process without having to worry about removing a chunk of text from the top of the file. Originally, this was attempted by using jinja2 if-statements, however the substitutions are replaced *after* the template is executed, so the condition would never match. The format of the variable is to make the templating happy. Using colons or percent signs results in the templator thinking something else is going on, and then complaining about format.	6 years ago
Travis Ralston	cee0a5ac7b	Merge pull request #1557 from turt2live/travis/general/r0-prep ... Prepare the identity service and server-server APIs for r0	6 years ago
Hubert Chathi	a1b1054aa1	fix handling of multi-line state key descriptions	6 years ago
Travis Ralston	2753d24302	Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep	6 years ago
Travis Ralston	827033c128	Merge remote matrix-org/master	6 years ago
Richard van der Hoff	f649d04ae1	Merge pull request #1626 from matrix-org/rav/encoding ... Set the encoding to UTF-8 on all file I/O	6 years ago
Richard van der Hoff	20c9829f56	Merge pull request #1627 from matrix-org/travis/general/dont-build-proposals ... Don't generate proposals.rst in Circle CI	6 years ago
Travis Ralston	ecd3ce39e5	Don't generate proposals.rst in Circle CI	6 years ago
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