Commit Graph

6721 Commits (57042769819f1fad921f54a8f0cd9ebb112ebb9c)
 

Author SHA1 Message Date
Richard van der Hoff adb5768731 m.room.power_levels: clarify documentation
- clarify description and add text for invite, ban, etc.
- the keys aren't required. Document their defaults
- add 'invite' to example
8 years ago
Richard van der Hoff 0be787a930 Merge pull request #340 from matrix-org/markjh/default_rule_change
Document changes to the default push rules
8 years ago
Richard van der Hoff 3085257d11 Merge pull request #338 from matrix-org/rav/yamlify_event_schemas
Convert event schemas to yaml
8 years ago
Richard van der Hoff e594132e95 m.room.member: yaml tweak
Quote "string" for consistency with "null"
8 years ago
Mark Haines af091ff614 Document changes to the default push rules 8 years ago
Mark Haines 30a3302921 Merge pull request #274 from matrix-org/markjh/default_rules
Update the predefined push rules in the spec
8 years ago
Erik Johnston e80e32173f Merge pull request #278 from matrix-org/erikj/presence
Update presence spec.
8 years ago
Erik Johnston 2691d4925b s/currently_online/currently_active/ 8 years ago
Richard van der Hoff 4875be05ce Give better error messages when parsing fails
An attempt to give slightly more helpful error messages when we have a problem
parsing an event schema file (in particular, which file contains the problem,
and which property within it).

A bit of light refactoring to make it tractable.
8 years ago
Richard van der Hoff 5b12e2cfef Convert event schemas to yaml
We've decided to make the event schemas YAML, so we might as well take
advantage of it.

(This conversion was done mostly automatically, except for:
 - s/null/"null"/ in m.room.member
 - reformat description in m.room.power_levels
8 years ago
Oddvar Lovaas 253b3a76df no longer lacking in features! 8 years ago
David Baker ec69f04793 Merge pull request #337 from matrix-org/rav/directory_docs
Improve documentation of directory API
8 years ago
Richard van der Hoff 7bbb664784 Improve documentation of directory API 8 years ago
Richard van der Hoff 2daf5e7c72 Merge pull request #336 from sbts/patch-1
Update Spec with info about recommended power name to number mapping
9 years ago
David 92bb1c1b43 Update wording as per request from richvdh 9 years ago
Richard van der Hoff 6aeb9f4595 Merge pull request #335 from nott/nott/add-pyyaml-to-scripts-readme
Add PyYAML to scripts/README.md
9 years ago
David a7e40bed88 Add powerlevel name to value list 9 years ago
Stas Rudakou b6c41727c5 Add PyYAML to scripts/README.md
PyYAML is a 3rd-party package used by `gendoc.py`.
9 years ago
Matthew Hodgson 666229073e fix 3pid mapping wording 9 years ago
Oddvar Lovaas 689177e2fc adding goMatrix 9 years ago
Oddvar Lovaas d4d2191d47 update links 9 years ago
Oddvar Lovaas a90e65d4e5 Feature Vector mobile clients on Try Matrix Now page 9 years ago
Richard van der Hoff 099d356dfb Add r0.1.0 to version list in C-S spec 9 years ago
Richard van der Hoff 2eebacacfe Merge pull request #286 from matrix-org/dbkr/default_state_defaults
Update spec to say what the default state / events defaults are
9 years ago
Richard van der Hoff 33ec8dde88 m.room.power_levels: More newlines 9 years ago
Richard van der Hoff 8c3838bc04 Formatting tweaks for m.room.power_levels 9 years ago
Richard van der Hoff 8b61dab1c6 gendoc.py: add --list_targets arg
I want to be able to run all of the targets except one from matrix-doc, so make
a way to list the targets.
9 years ago
Richard van der Hoff 69c2eb7edb Merge pull request #333 from matrix-org/rav/back_to_r0.1.0
Next release will be 0.1.0, not 1.0.0
9 years ago
Richard van der Hoff 590c55b760 Next release will be 0.1.0, not 1.0.0
Since synapse is already doing the new behavior on r0 endpoints, and nobody
wants to support the old behaviour, we're defining the new behaviour as r0.1.
9 years ago
Richard van der Hoff 8f4d7c95df Include '..' lines in changelogs
Not all lines starting with '..' are comments, and even if they are comments,
they might as well go into the generated spec ReST.
9 years ago
Richard van der Hoff 86a81b0450 Fix schema for /logout
'properties' is a map, not a list
9 years ago
Richard van der Hoff e7e9f5fa46 Document the /logout api
We have one, and it's useful, so we really ought to document it
9 years ago
Richard van der Hoff 2e446594a1 Merge pull request #328 from matrix-org/rav/auth_api_docs
Tidy up the client-authentication spec
9 years ago
Oddvar Lovaas d52377274f adding vector mobile clients 9 years ago
Richard van der Hoff 3bce28a15c Clarifications to the 'Client authentication' section
* Use the terminology 'login type' everywhere instead of mixing up 'stage type'
  and 'login type'

* Don't have a separate 'APIs using the User-Interactive Authentication
  mechanism' section, because (a) it doesn't make much sense to organise the
  APIs this way, and (b) it was a set of lies anyway.

* Move '/account/password' definition into registration.yaml so that register
  and password can share a section in the spec; remove duplicate doc for
  /password.

* Write some words on using 3pids for /login
9 years ago
Richard van der Hoff 2093a6bac9 Merge pull request #332 from matrix-org/rav/update_login_api
Update the /login API spec
9 years ago
Richard van der Hoff 2cbebbe506 Merge pull request #331 from matrix-org/rav/doc_interactive_api_params
Document the user-interactive api params
9 years ago
Richard van der Hoff 959f1ff09f Update the /login API spec
Note that /login can be used with 3pid creds
9 years ago
Richard van der Hoff 9efd021f5e Document the user-interactive api params
Document the parameters and responses on /register and /account/password which
are invoved in the user-interactive auth
9 years ago
Richard van der Hoff 0cdc2da5bf Merge pull request #330 from matrix-org/rav/improve_examples
Improve API examples in the spec
9 years ago
Richard van der Hoff 167b84cc7f Another go at formatting examples
Let's try to avoid parsing the JSON, as it will reorder the examples.
9 years ago
Richard van der Hoff 45199d0edc Attempt to parse examples as json
... because some of them are, and we don't want to double-escape them.
9 years ago
Richard van der Hoff 6b23598a26 Improve API examples in the spec
* Show response codes even if we don't have examples for them
 * Walk the objects to build param examples if none are given at the top level
9 years ago
Richard van der Hoff 2d28e5abce Fix basePath on /redact API doc 9 years ago
Richard van der Hoff d1fd9de10e Merge pull request #329 from matrix-org/rav/basepath_in_swagger
Include the basePath in the path in swagger output
9 years ago
Richard van der Hoff f46a2a7f2b Include the basePath in the path in swagger output
This fixes both SPEC-393, and ORG-52.
9 years ago
Oddvar Lovaas 85ad53ae70 encourage contributions! 9 years ago
Oddvar Lovaas 771b21a316 add new guides to guide page 9 years ago
Richard van der Hoff b0284f0c7e Merge pull request #327 from matrix-org/rav/no_sort_api
Don't sort the HTTP APIs
9 years ago
Richard van der Hoff 695a533e45 Don't sort the HTTP APIs
We can order them manually in the YAML, so why would we want a completely
different order in the spec?
9 years ago