matrix-spec-proposals

Commit Graph

Author	SHA1	Message	Date
Travis Ralston	95d850c418	Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421 ) * Blind find & replace all on client major version -> v3 * Fix up bad replacements * Fix anchors for r0->v3 * Changelog	3 years ago
Andrew Fargo	43a71c0092	Remove all references to speculator (#3430 ) Signed-off-by: DCFargo <drew.fargo@gmail.com>	3 years ago
Alexandre Franke	26c0c88882	🐛 Fix OpenAPI definition generation (#3418 ) Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org> Co-authored-by: Alexandre Franke <alexandre.franke@matrix.org>	3 years ago
Alexandre Franke	423d22ed23	✨ Add API Server config for RapiDoc (#3415 ) * ✨ Add API Server config for RapiDoc Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org> * Update scripts/dump-swagger.py Co-authored-by: Alexandre Franke <alexandre.franke@matrix.org> Co-authored-by: Travis Ralston <travisr@matrix.org>	3 years ago
Alexandre Franke	845e4c87db	🐛 Fix handling of postponed proposals (#3397 ) Fixes #3396 Signed-off-by: Alexandre Franke <alexandre.franke@gmail.com>	3 years ago
Alexandre Franke	cbe3081685	🐛 Handle empty bodies when fetching MSCs (#3374 ) Signed-off-by: Alexandre Franke <alexandre.franke@gmail.com>	3 years ago
Travis Ralston	b455fc73f1	Reference drafts properly	3 years ago
Travis Ralston	8d73a17f5b	Cut out legacy build scripts	3 years ago
Andrew Morgan	a17023962c	Update CircleCI and Buildkite configs to build the new spec (#3017 ) This PR attempts to update the CI of matrix-doc to build [the new spec redesign](https://github.com/matrix-org/matrix-doc/issues/2906). It does so by additionally building the new spec in parallel to the old. The plan is to continue to host the old spec at https://matrix.org/docs/spec, while the new spec will be at https://spec.matrix.org. Eventually we will retire the old version of the spec, and have the old URL redirect to the new one. In detail, this PR: * Adds a new step to CircleCI to build the new spec with `hugo`. This step uses alpine, grabs some dependencies, and then builds the HTML. * We needed to hand some specific options to hugo for CircleCI in order to continue allowing CircleCI to host temporary builds of the spec after each CI run. This required changing some assumptions related to relative paths. * CircleCI's artifacts hosting is also quite limited. Specifically it will not automatically resolve `/some/path` to `/some/path/index.html`, which our hugo theme relied on. Fixes were implemented for this, but we may want to consider switching away from CircleCI artifacts as a host, and using something like [netlify](https://www.netlify.com/) instead. * Modifies the existing Buildkite pipeline step to build both the new spec in a separate step. It additionally modifies the old spec to be built with alpine. (Separate out into another PR) * We'd like to separate out the deployment of matrix.org from the new spec. Therefore a new step, with a separate artifact build (`spec.tar.gz`). We will eventually remove the old step and the matrix.org build trigger. * Modifies `pyproject.toml` to update the config of [giles](https://github.com/OpenAstronomy/baldrick/blob/master/baldrick/plugins/circleci_artifacts.py), which is what creates the "docs", "swagger" links in the CI steps for matrix-docs PRs. * A new step was added for the new spec. The old spec was renamed to "legacy".	3 years ago
Andrew Morgan	25605b65a3	Don't generate matrix assets on CircleCI (#3034 ) We already do this in the buildkite pipeline, so doing so in CircleCI is just duplicate work.	3 years ago
Will	643cdd19c8	Support rendering of proposal tables	3 years ago
Will	a0316f6794	Update path to Swagger files	3 years ago
Will	00c6a866e2	Move raw API and event schemas into /data directory Historical note: this was originally a series of several commits, spread out over several weeks. They have been squashed together to make `git annotate` work properly. The original commits were: * `91ab3934` <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory * `aae22f47` <Will> 2021-01-25 21:33:06 -0800 Remove non-data files * `1092d4ca` <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one * `21060109` <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly * `4f633845` <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too * `301c7b2f` <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use	3 years ago
Andrew Morgan	3c66e149f3	Move validator.js to scripts/ directory, update calls	3 years ago
Andrew Morgan	64231f079d	Update checker scripts to work correctly from the scripts/ dir check-swagger-sources also had a bug which caused it to fail while validating the directory structure of /data/api. This was fixed by @KitsuneRal - thank you!	3 years ago
Andrew Morgan	b8dafe86f4	Move and more aptly name check_examples.py scripts	3 years ago
Will	deef4f5e7c	Suppress bullets inside table of contents	4 years ago
Travis Ralston	f0ba7f014b	Update i18n for emoji	4 years ago
Travis Ralston	d37f7a25b4	Make translations for SAS emoji available in-tree (#2728 ) * add a base file * Fix directory name * Added translation using Weblate (English) * Translated using Weblate (English) Currently translated at 1.6% (1 of 64 strings) Translation: matrix-doc/SAS Emoji v1 Translate-URL: https://translate.riot.im/projects/matrix-doc/sas-emoji-v1/en_EN/ * add english files * delete english files * Added translation using Weblate (English) * Added translation using Weblate (English) * Do manual translations * Deleted translation using Weblate (English) * Deleted translation using Weblate (English) * Add a script to update the definitions with the translations * update i18n * Add a note to the spec about translations * changelog * Ensure translations end with json	4 years ago
Kitsune Ral	8e7c0dfb93	Merge remote-tracking branch 'origin/master' into kitsune/cleanup	4 years ago
Travis Ralston	ffea5d5e61	Document top-level UnsignedData objects	5 years ago
Kitsune Ral	b789f3e10b	dump-swagger.py: fix a typo in the help string	5 years ago
Travis Ralston	e14cf35c80	Merge pull request #2563 from matrix-org/travis/spec/2240-and-assoc--r-v6 Room Version 6	5 years ago
Travis Ralston	93f68866c5	Fix spec generation not using titles on pseudo objects	5 years ago
Travis Ralston	74c51b05a4	Incorporate MSC2209 (`notifications` auth rules) MSC: https://github.com/matrix-org/matrix-doc/pull/2209 The changes are slightly difficult to word without dumping the text in and playing a game of spot the difference, so we now use our pre-existing pygments support to render a representation of the difference. The difference is shown in markdown-like format instead of RST for ease of understanding. It's also not rendered HTML for largely complexity reasons.	5 years ago
Ben Parsons	7c037d2490	improve capture and add example	5 years ago
Ben Parsons	5ae8a8bcfd	fix pagination in scraper	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
Travis Ralston	de3802cd5c	List deprecated endpoints as deprecated Affects the title and the table of contents. We can't realistically alter just the table of contents, but the table of contents is generated from this header. Fixes https://github.com/matrix-org/matrix-doc/issues/1800	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>	6 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>	6 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".	6 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	6 years ago
Travis Ralston	4b6e2cc956	Merge pull request #2072 from matrix-org/travis/1.0/msc1717-msc1267-sas-verification Spec SAS verification and the common key verification framework	6 years ago
Travis Ralston	79bbb47d9f	Clarify when authorization and rate-limiting are not applicable Fixes https://github.com/matrix-org/matrix-doc/issues/1971	6 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	9ac89cc915	Merge pull request #2056 from matrix-org/travis/1.0/membership-table Add a table to show how changes in membership should be interpreted	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	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

1 2 3 4 5 ...

363 Commits (95d850c418ee544a25ee33c19c8fd65deedbf868)