Commit Graph

46 Commits

Author SHA1 Message Date
Travis Ralston 2e3e189ea2 Merge remote matrix-org/master 2018-08-31 09:31:39 -06:00
Hubert Chathi 5019fb7c49
Merge pull request from uhoreg/well-known
.well-known discovery
2018-08-29 10:40:54 -04:00
Travis Ralston 6cdb463829
Merge pull request from turt2live/travis/general/number-to-int
Replace applicable types of 'number' to 'integer'
2018-08-28 07:40:28 -06:00
Travis Ralston 55c0b968b5 Fix event schemas for /sync
This commit clarifies the required keys for each type of event that appears in sync, fixes the core event schema not declaring 'content' as required, and includes a mention that events may not have a room_id when appearing in /sync.

Fixes https://github.com/matrix-org/matrix-doc/issues/595
Fixes https://github.com/matrix-org/matrix-doc/issues/909
2018-08-26 22:22:36 -06:00
Travis Ralston 667fa082af Replace applicable types of 'number' to 'integer'
`number` implies/represents a float where `integer` does not.

The only remaining `type: number` in the project appear on power levels: those have been left untouched pending clarification.

Fixes https://github.com/matrix-org/matrix-doc/issues/746
2018-08-26 21:32:44 -06:00
Travis Ralston b68ed5d594 Define the default for the contains_url filter param
Fixes https://github.com/matrix-org/matrix-doc/issues/1553
2018-08-26 21:21:49 -06:00
Travis Ralston 97e3dd443b Update room_event_filter.yaml to use the OpenAPI allOf definition
This is just maintenance.
2018-08-26 21:20:01 -06:00
Travis Ralston 7d08ef73d0 Fix naming of the Filter schemas
EventFilter !== Filter

Fixes https://github.com/matrix-org/matrix-doc/issues/1509
2018-08-26 21:19:07 -06:00
Hubert Chathi fcca80dad8 various minor fixes
- formatting fixes
- add examples to homeserver/identity server discovery schema
- replace DNS name with hostname
2018-08-14 17:58:57 -04:00
Hubert Chathi 6a3cf10be9 Merge remote-tracking branch 'origin/master' into well-known 2018-08-14 17:00:56 -04:00
Hubert Chathi 292d334509
document new login identifier object () 2018-08-10 16:19:17 -04:00
Travis Ralston 2ac80d38d7 Document the /publicRooms endpoint for federation
This intentionally doesn't document the third party network aspect of the endpoint. This is scheduled for a later area for dealing with third party network/IDs and is reported as https://github.com/matrix-org/matrix-doc/issues/1476

The client-server response has been broken out to a shared file: both the client-server and server-server /publicRoom endpoints return the same thing, with slightly different inputs.

The inputs (and behaviour) are based upon the docstring here: 43ecfe0b10/synapse/federation/transport/server.py (L583-L612)
2018-08-03 11:23:44 -06:00
Travis Ralston 16125f16f5 Spec retry_after_ms on ratelimit errors 2018-07-12 09:28:30 -06:00
Hubert Chathi 5bc29eb11c remove accidentally-committed backup file 2018-07-04 17:01:35 -04:00
Travis Ralston 7cd22f5690 Describe the rate limit error everywhere
Fixes https://github.com/matrix-org/matrix-doc/issues/1153
2018-07-04 13:45:34 -06:00
Hubert Chathi 0dd330962d initial draft of .well-known discovery 2018-07-03 14:14:26 -04:00
Jason Volk de6d2c96fe Minor grammar fix. 2018-02-13 18:55:36 -08:00
Maxime Dor dcaaf84395 Be clear that event_id is not applicable everywhere 2017-11-09 15:28:44 +01:00
Maxime Dor efa9b5a8f1 Add missing required key for sync format 2017-11-09 02:10:23 +01:00
Richard van der Hoff da6938b818 Key management APIs ()
Spec the e2e key-management APIs.
2017-04-20 16:51:42 +01:00
Richard van der Hoff af515012ea Device management API 2016-10-12 17:26:01 +01:00
Richard van der Hoff f4c7fdfd03 Remove references to refresh tokens and tokenrefresh
refresh tokens are dead.
2016-10-03 17:05:56 +01:00
Erik Johnston 7919e8e159 Update wording. 2016-09-30 15:02:27 +01:00
Erik Johnston 085131b617 Add contains_url filter option 2016-09-29 13:37:08 +01:00
Benjamin Saunders cade909e25 Fix inconsistencies regarding redacted_because
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
2016-08-30 21:18:55 -07:00
Richard van der Hoff 8328e485ea Clean up the pushrules API doc
* make it clearer which fields go in which parts of the rule
* the example given appeared to be for a content rule, so use a content rule
  consistently through the examples.
2016-07-27 13:54:35 +01:00
Richard van der Hoff 49cd65dd58 Add a license to the spec
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
2016-07-12 17:28:30 +01:00
Benjamin Saunders ee5054fb42 Supply prev_batch unconditionally in timelines
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
2016-07-07 01:37:48 -07:00
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
2016-05-06 16:47:49 +01:00
Richard van der Hoff 5383754a40 Access event-schemas via a symlink
Swagger gets a bit confused about $refs via '../..', so use a symlink to make
everything nicely relative.
2016-05-04 14:39:52 +01:00
Richard van der Hoff 23c4ffbc1b Add securityDefintions to generated swagger JSON
Also factor out to a common file
2016-05-03 13:57:16 +01:00
David Baker e6143a6596 Merge pull request from matrix-org/dbkr/fix_meta_escaping
Fix meta-escaping fail
2016-02-24 14:15:55 +00:00
David Baker 2c5392f1d1 Fix meta-escaping fail 2016-02-24 14:00:57 +00:00
Mark Haines 3db6980e0b Remove references to device specific push rules
Since they weren't implemented on the servers and weren't
used by the clients.
2016-02-18 16:05:47 +00:00
Richard van der Hoff ff26e0dc48 Add some missing titles to the filter upload spec 2016-01-07 18:31:09 +00:00
Mark Haines 4c43939977 more backticks 2015-12-22 11:48:11 +00:00
Mark Haines 9b4a37f57b backticks 2015-12-22 11:44:05 +00:00
Mark Haines 288c7ed353 Add top level filters for filtering by room id. 2015-12-21 20:44:06 +00:00
Mark Haines 2ea66e9300 Merge branch 'markjh/account_data_filters' into markjh/room_filter 2015-12-21 20:38:50 +00:00
Mark Haines a32ed96a0f Document filtering for account data 2015-12-21 20:31:02 +00:00
Mark Haines c9349b302a Filters don't support wildcards for senders or room ids 2015-12-21 17:17:28 +00:00
Daniel Wagner-Hall f81b967e2d Make all the schema files yaml 2015-12-07 13:56:36 +00:00
Mark Haines 140206ca69 s/archived/leave/ 2015-12-04 17:32:59 +00:00
Mark Haines 79d109f7cc Add an flag to control whether rooms the user has left are included in the sync 2015-12-04 16:44:11 +00:00
Daniel Wagner-Hall 7f07da4b50 Remove obsolete documentation 2015-12-01 17:29:09 +00:00
Daniel Wagner-Hall 6c66bfc755 Flatten out v1 and v2_alpha directories
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
2015-11-30 11:22:57 +00:00