61 Commits (3a649839c27a13ccddebeb1c3253cf69979cddeb)

Author	SHA1	Message	Date
Travis Ralston	ffea5d5e61	Document top-level UnsignedData objects	4 years ago
Travis Ralston	93f68866c5	Fix spec generation not using titles on pseudo objects	5 years ago
Kitsune Ral	6b37bb1dd9	Merge remote-tracking branch 'remotes/origin/master' into kitsune-map-to-enum-support	5 years ago
Travis Ralston	afd5018494	Spec the terms of service handling for identity servers ... Part of MSC2140 Convert status codes to strings if there is a string status code. Fixes a build error when we mix 4xx and 403 in the same definition. We also have to correct stringified numbers to pass the build.	5 years ago
Kitsune Ral	65cd10249c	Render enums inside additionalProps as one more table ... Closes #2242.	5 years ago
Jimmy Cuadra	5384b61d95	Fix style issues brought up during code review. ... Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>	5 years ago
Jimmy Cuadra	bc71dacaf4	Clarify the distinction between *m.key.verification.start* and its *m.sas.v1* variant. ... Currently the *m.key.verification.start* event appears twice with the exact same title, in the "Key verification framework" section and the "Short Authentication (SAS) verification" section. It's not immediately clear that the first occurrence describes the format of the event in general terms and that the second occurrence describes the fields when the *m.sas.v1* verification method is being used. This is a similar relationship to the *m.room.message* event and its various *msgtype* variants. This commit does three things: * It tweaks the generation of the documentation to change the title of the second occurrence of *m.key.verification.start* to distinguish it from the first. * It updates the language in the description of the two versions of the event to better describe the relationship between the two. * It adds the optional `next_method` field to the schema of the *m.sas.v1* variant, as specified in the general form of *m.key.verification.start*. Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>	5 years ago
Travis Ralston	e60d2defbd	Fix changelog generation ... Only include the target version, not all versions. Additionally, make sure the appservice spec isn't hardcoded as "unstable".	5 years ago
Travis Ralston	2d18f81807	Merge pull request #2087 from matrix-org/travis/1.0/events-are-extensible ... Reorganize event structure in c2s spec and clarify event capabilities	5 years ago
Travis Ralston	8fd5b15594	Reorganize event structure in c2s spec and clarify event capabilities ... Fixes https://github.com/matrix-org/matrix-doc/issues/1166 Fixes https://github.com/matrix-org/matrix-doc/issues/1527 Fixes https://github.com/matrix-org/matrix-doc/issues/1827 Note: In order to fix the "state events have the following fields: [no words]" bug (1827) we need to resolve references on common event types. When doing this we ultimately end up with more fields than may be required to explain the section, however this commit alters the section descriptions to just say "these fields" instead of "these additional fields". This is also preferable over trying to get the inheritance reversed in the common event types, as the `/sync` endpoint has a high amount of reliance on partial events definitions.	6 years ago
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	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
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	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
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
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
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	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
Travis Ralston	a5c3924492	Merge remote matrix-org/master	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
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	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	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
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	a4e5a461f9	Improve handing of lists appearing in items	6 years ago
Travis Ralston	e226b60c7f	Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger	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