Travis Ralston
5bf99aeb34
Add a note that formatted_body is not forever
2018-08-27 09:17:08 -06:00
Travis Ralston
c7822cc9a8
Link to the content repo when referencing MXC URIs in images
2018-08-27 09:16:53 -06:00
Travis Ralston
d7d28f7e5b
Remove nl as a supported HTML tag
2018-08-27 09:16:30 -06:00
Travis Ralston
ce0befd7d0
Changelog
2018-08-26 22:28:52 -06:00
Travis Ralston
e60b44e27f
Clean up PUT /directory/room
...
Fixes https://github.com/matrix-org/matrix-doc/issues/933
The issue references two problems: a `roomInfo` and lack of a `room_id`. It appears the `room_id` has been fixed since reporting, however the `roomInfo` remained (and is now fixed).
2018-08-26 22:27:34 -06:00
Travis Ralston
fd47184ce3
Changelog
2018-08-26 22:23:38 -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
e8edfba114
Changelog
2018-08-26 21:57:04 -06:00
Travis Ralston
008ebb8c1a
Add account_data to left rooms in /sync
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1392
2018-08-26 21:55:30 -06:00
Travis Ralston
e75a1836b8
Changelog
2018-08-26 21:33:43 -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
b0fbd7be7c
Changelog
2018-08-26 21:24:33 -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
1cbcaba2c7
Clean up examples in filter.yaml
...
Indentation, excess examples.
2018-08-26 21:21:27 -06:00
Travis Ralston
26a7a341f0
Mark the filter_id in the response of POST /filter as required
2018-08-26 21:21:02 -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
Travis Ralston
e926b4a840
Changelog
2018-08-26 21:05:09 -06:00
Travis Ralston
1bc0f63bfb
Clarify the homeserver's behaviour for user searching
...
The homeserver can implement its own algorithm, but is suggested to ensure the requesting user can reasonably see the other users.
The text is intentionally left vague for whether or not the API is local users only to give the homeserver some flexibility in this area.
General cleanup is also included in this commit.
Fixes https://github.com/matrix-org/matrix-doc/issues/1108
2018-08-26 21:04:02 -06:00
Travis Ralston
3b2bf18c67
Changelog
2018-08-26 20:54:22 -06:00
Travis Ralston
5ceb132110
Changelog
2018-08-26 20:52:59 -06:00
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
2018-08-26 20:51:39 -06:00
Travis Ralston
b4be11af42
Document POST /account/3pid/delete
...
Fixes https://github.com/matrix-org/matrix-doc/issues/985
Includes documentation for https://github.com/matrix-org/synapse/pull/3667
Raises https://github.com/matrix-org/matrix-doc/issues/1566
2018-08-26 20:41:34 -06:00
Travis Ralston
a803d9d077
Document validated_at and added_at on GET /3pid
...
Fixes https://github.com/matrix-org/matrix-doc/issues/661
2018-08-26 20:39:53 -06:00
Travis Ralston
be9f6042e5
Fix encrypted event examples
2018-08-25 23:24:02 -06:00
Travis Ralston
0a6c1c4dda
Ensure the event examples and matrix.org assets are tested
...
Otherwise we go nearly a week without realizing the build is failing due to bad schemas/examples. This also helps us ensure a PR is up to par.
This commit is expected to cause a build failure at this time. A future commit will actually fix the project and address concerns raised by the testing.
2018-08-25 23:19:24 -06:00
Travis Ralston
e5a7dd1c45
Remove excess commas from JSON
2018-08-25 23:00:26 -06:00
Travis Ralston
3c472f70e3
Changelog
2018-08-25 22:59:22 -06:00
Travis Ralston
aa294fac06
Define the supported HTML subset for message events
...
Also clarify that `m.notice` messages can support HTML.
Fixes https://github.com/matrix-org/matrix-doc/issues/1559
Fixes https://github.com/matrix-org/matrix-doc/issues/1560
2018-08-25 22:57:52 -06:00
Travis Ralston
312799ae78
General clarification for mention and how matrix.to URIs are meant to work
2018-08-25 22:30:49 -06:00
Travis Ralston
295b1322e2
Add back the unsigned.age property to voip event examples
2018-08-25 22:26:23 -06:00
Travis Ralston
32ce676eb6
Merge pull request #1561 from QMatrixClient/kitsune-fix-type-in-openid
...
openid.yaml: int is not a valid Swagger type
2018-08-25 09:48:59 -06:00
Valentin Deniaud
d6f5d590f8
add encrypted attachments changelog
2018-08-25 17:31:49 +02:00
Valentin Deniaud
b7577ea237
document encrypted attachments
...
Fix #461 .
2018-08-25 17:31:49 +02:00
Valentin Deniaud
faa13aaa40
fixup! add key sharing changelog
2018-08-25 17:28:01 +02:00
Valentin Deniaud
f6b5aee3e2
explain how to use key sharing events
2018-08-25 17:27:18 +02:00
Valentin Deniaud
579f5ea928
fixup! document key sharing and m.room_key_request
2018-08-25 17:26:40 +02:00
Valentin Deniaud
8ae137e82e
fixup! document m.forwarded_room_key
2018-08-25 17:26:00 +02:00
Valentin Deniaud
768f33dc2d
fixup! document key sharing and m.room_key_request
2018-08-25 16:55:28 +02:00
Valentin Deniaud
337316445f
fixup! document m.forwarded_room_key
2018-08-25 16:55:00 +02:00
Kitsune Ral
c879eb950f
client-server/openid.yaml: Fix a type'o
...
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
2018-08-25 22:49:12 +09:00
Travis Ralston
06d43aef17
Changelog
2018-08-24 18:08:05 -06:00
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
2018-08-24 18:04:51 -06:00
Travis Ralston
d370a2c6fd
Prepare the identity service and server-server APIs for r0
...
* Create the changelog scaffolding
* Set up the variables for versioning
2018-08-24 17:19:25 -06:00
Travis Ralston
dafea96621
Fix indentation and schema references in the identity service spec
2018-08-24 15:53:27 -06:00
Travis Ralston
4abd618147
Flag response fields in the Identity Service spec as required
2018-08-24 15:53:00 -06:00
Travis Ralston
811998735c
Define common error codes in the Identity Service API
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1407
2018-08-24 15:51:23 -06:00
Travis Ralston
9b19fc27de
changelog
2018-08-24 11:09:55 -06:00
Travis Ralston
017d6db737
Document third party network/protocol directories (for appservices)
...
Fixes https://github.com/matrix-org/matrix-doc/issues/869
2018-08-24 11:07:30 -06:00
Travis Ralston
2d43ff1234
Update third party network schemas
...
Some information was missed when this was reviewed. This commit adds some additional documentation for how these objects interact with each other.
2018-08-24 10:48:47 -06:00