Commit Graph

911 Commits (f7c7a74092dc7b0b157565593b9b8057cec55bd4)

Author SHA1 Message Date
Travis Ralston afa16f1e4e
Merge pull request #1606 from turt2live/travis/c2s/room-tags
Update the room tagging documentation
6 years ago
Travis Ralston 73736d41db
Merge pull request #1569 from turt2live/travis/c2s/user-directory
Clarify the homeserver's behaviour for user searching
6 years ago
Travis Ralston 4bd23a9086 send_attempt is no longer optional 6 years ago
Travis Ralston 7f719b23e7
Merge pull request #1589 from turt2live/travis/c2s/inhibit-login
Document the inhibit_login registration option
6 years ago
Travis Ralston dfaed5b525 Clean up and flesh out all three editions of the /requestToken API
Fixes https://github.com/matrix-org/matrix-doc/issues/1634

Addresses some of https://github.com/matrix-org/matrix-doc/issues/1396
6 years ago
Travis Ralston ce14779af1
Merge pull request #1567 from turt2live/travis/c2s/3pid-binding
Document `validated_at`, `added_at`, and POST /3pid/delete
6 years ago
Travis Ralston 5da3072eef Wording change ('may not' has a special meaning) 6 years ago
Travis Ralston 2a08a308f3 device_keys are required 6 years ago
Travis Ralston 219b27b182 Merge remote matrix-org/master 6 years ago
Travis Ralston f923d08078 Add read markers
This is the spec for https://github.com/matrix-org/matrix-doc/issues/910

Fixes https://github.com/matrix-org/matrix-doc/issues/910

Some reverse engineering was required to work out the complete details as to how this works. In particular, the 405 for setting account data and the behaviour of m.read.

References:
* 405 for account data: d69decd5c7/synapse/rest/client/v2_alpha/account_data.py (L85-L90)
* m.read behaviour: d69decd5c7/synapse/rest/client/v2_alpha/read_marker.py (L45-L52)
6 years ago
Richard van der Hoff 0f84c69805
Merge branch 'master' into rav/clarify_event_signing 6 years ago
Travis Ralston 8bcd7d26e3 /3pid/delete returns an empty object 6 years ago
Travis Ralston 390f1c16f7 Remove mentions of identity services from /3pid/delete
This will be covered by https://github.com/matrix-org/matrix-doc/issues/1194

For now, we can accept that homeservers may try to unbind, however clients should not rely on it.
6 years ago
Travis Ralston 86c85aea71 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/3pid-binding 6 years ago
Travis Ralston d57b977a55 Merge branch 'm-master' into travis/general/3pid_invite 6 years ago
Travis Ralston e82c22b060
Merge pull request #1615 from turt2live/travis/is/touchups
Touch up more of the identity service specification
6 years ago
Travis Ralston f09db16027 Merge remote-tracking branch 'matrix-org/master' into travis/s2s/key-mgmt 6 years ago
Travis Ralston 49c5677969 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/user-directory 6 years ago
Travis Ralston f04afaa9b9
Merge pull request #780 from mujx/missing-enum-fields
Add missing enum fields for the set_presence parameter
6 years ago
Travis Ralston cc1e496287
Merge pull request #1629 from turt2live/travis/as/route-versions
Version all appservice endpoints and provide a fallback
6 years ago
Travis Ralston 0f2e01f5b5
Merge pull request #1555 from turt2live/travis/as/cleanup
Application service spec cleanup; Security definitions; r0 prep
6 years ago
Travis Ralston be5c566028 Version all appservice endpoints and provide a fallback
Fixes https://github.com/matrix-org/matrix-doc/issues/1616
6 years ago
Travis Ralston 6b52e1df77
Merge pull request #1587 from turt2live/travis/s2s/clarify-state-ids-inclusion
Clarify that the requested event is excluded from /state and /state_ids
6 years ago
Richard van der Hoff 55c4307f12 Rewrite the section on signing events
... for clarity and de-duplication. And to say a bit about validating the
signatures.
6 years ago
Travis Ralston 7ecf2406eb
Merge pull request #1590 from turt2live/travis/c2s/403-put-state
Document 403 error for sending state events
6 years ago
Travis Ralston a5c3924492 Merge remote matrix-org/master 6 years ago
Travis Ralston f030d19f3c Clean up identity service swagger
* Add `consumes` (swagger)
* Remove `http` as a supported scheme (the spec specifically says clients MUST use https)
* Clarify various descriptions
  * Full stops
  * Additional wording
  * s/older versions/previous drafts - we haven't had a release yet
* Indentation on examples
6 years ago
Travis Ralston 684d80c422 Revert changes to 3pid lookup types in the IS spec
The validator doesn't know what a "3PID Medium" is, for example, so it throws exceptions. This does reduce clarity in the spec though.
6 years ago
Travis Ralston abb91508be
Merge pull request #1556 from turt2live/travis/is/cleanup
Identity Service API cleanup
6 years ago
Travis Ralston c03f2f8d79 Minor touchups to the room tagging API
Fixes some of https://github.com/matrix-org/matrix-doc/issues/1565
6 years ago
Kitsune Ral 9bc1470305 Elaborate the structure of m.tag events
...and corresponding structures in tag-related CS API calls

Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
6 years ago
Travis Ralston f2d02c9559 Take out device management section for now
This will be handled by the implementation of https://github.com/matrix-org/matrix-doc/issues/1212
6 years ago
Travis Ralston 5ff244f06b More clarification about how /state_ids works 6 years ago
Travis Ralston de36d97839 Clarify which event is actually be excluded from /state_ids 6 years ago
Hubert Chathi 5019fb7c49
Merge pull request #1359 from uhoreg/well-known
.well-known discovery
6 years ago
Erik Johnston 7327656965
Merge pull request #1581 from matrix-org/erikj/limit_txn_size
Specify a limit on the number of EDUs and PDUs a transaction can contain
6 years ago
Travis Ralston d91395cf9f Document 403 error for sending state events
Fixes https://github.com/matrix-org/matrix-doc/issues/1399
6 years ago
Travis Ralston 1051aff108 Document the inhibit_login registration option
Fixes https://github.com/matrix-org/matrix-doc/issues/1351
6 years ago
Travis Ralston dad037170a Clarify that the requested event is excluded from /state and /state_ids
Fixes https://github.com/matrix-org/matrix-doc/issues/1564
6 years ago
Travis Ralston 436544b8f8 Clarify behaviour of `?set_presence=unavailable` for /sync 6 years ago
Travis Ralston adef7babfa Merge remote-tracking branch 'matrix-org/master' into mujx/missing-enum-fields 6 years ago
Travis Ralston ad068bcd22 Fix the appservice directory visibility type parameter type 6 years ago
Travis Ralston e9579a7840 The `rank` in search results is actually a floating point number
This was accidentally changed in https://github.com/matrix-org/matrix-doc/pull/1571 and appears to be the only instance.
6 years ago
Erik Johnston fc1fdc95af Specify a limit on the number of EDUs and PDUs a transaction can contain 6 years ago
Travis Ralston 6cdb463829
Merge pull request #1571 from turt2live/travis/general/number-to-int
Replace applicable types of 'number' to 'integer'
6 years ago
Travis Ralston f9c7014a65
Merge pull request #1577 from turt2live/travis/c2s/search-filter
Specify the type of filter the search API expects
6 years ago
Travis Ralston 03065b0584
Merge pull request #1572 from turt2live/travis/c2s/sync-left-account-data
Add `account_data` to left rooms in /sync
6 years ago
Travis Ralston f2332d242a Add some SHOULDs and MUSTs to the user directory requirements 6 years ago
Travis Ralston bb515d15a4 Clarify which collation to use for user directory searching 6 years ago
Travis Ralston 9527ce31f5
Merge pull request #1570 from turt2live/travis/c2s/sync-filtering
Update filtering API documentation
6 years ago
Travis Ralston f01cfa2c7b Add security definitions to hs->as endpoints 6 years ago
Travis Ralston 17e0ef4b91 Remove empty file and now-empty section from the appservice spec
This commit has approval under https://github.com/matrix-org/matrix-doc/pull/1555 although is being included in this branch/PR so the build passes, permitting a merge.
6 years ago
Travis Ralston 51193cac39 Merge remote-tracking branch 'matrix-org/master' into travis/as/normal-events 6 years ago
Travis Ralston 87133d8505
Merge pull request #1574 from turt2live/travis/c2s/fix-directory-put
Clean up PUT /directory/room
6 years ago
Travis Ralston a0b17e6ed6
Merge pull request #1551 from turt2live/travis/c2s/push-rules
General improvements to the push rules module
6 years ago
Travis Ralston 97508d5dc5
Merge pull request #1554 from turt2live/travis/general/appservice-directories
Application service room directories (and other third party network things)
6 years ago
Travis Ralston 32ac81c588 Spelling 6 years ago
Travis Ralston 5fa6b49365 Specify the type of filter the search API expects
Note: This is badly named until https://github.com/matrix-org/matrix-doc/pull/1570 lands

Fixes https://github.com/matrix-org/matrix-doc/issues/598
6 years ago
Travis Ralston 8069981252 Add federation /user/* endpoints
Fixes https://github.com/matrix-org/matrix-doc/issues/1438
6 years ago
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).
6 years ago
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
6 years ago
Travis Ralston 008ebb8c1a Add `account_data` to left rooms in /sync
Fixes https://github.com/matrix-org/matrix-doc/issues/1392
6 years ago
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
6 years ago
Travis Ralston b68ed5d594 Define the default for the contains_url filter param
Fixes https://github.com/matrix-org/matrix-doc/issues/1553
6 years ago
Travis Ralston 1cbcaba2c7 Clean up examples in filter.yaml
Indentation, excess examples.
6 years ago
Travis Ralston 26a7a341f0 Mark the filter_id in the response of POST /filter as required 6 years ago
Travis Ralston 97e3dd443b Update room_event_filter.yaml to use the OpenAPI allOf definition
This is just maintenance.
6 years ago
Travis Ralston 7d08ef73d0 Fix naming of the Filter schemas
EventFilter !== Filter

Fixes https://github.com/matrix-org/matrix-doc/issues/1509
6 years ago
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
6 years ago
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
6 years ago
Travis Ralston a803d9d077 Document `validated_at` and `added_at` on GET /3pid
Fixes https://github.com/matrix-org/matrix-doc/issues/661
6 years ago
Kitsune Ral c879eb950f client-server/openid.yaml: Fix a type'o
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
6 years ago
Travis Ralston dafea96621 Fix indentation and schema references in the identity service spec 6 years ago
Travis Ralston 4abd618147 Flag response fields in the Identity Service spec as required 6 years ago
Travis Ralston 017d6db737 Document third party network/protocol directories (for appservices)
Fixes https://github.com/matrix-org/matrix-doc/issues/869
6 years ago
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.
6 years ago
Travis Ralston 9eda1a6971 Move the third party network API to it's own section 6 years ago
Travis Ralston 6a91ea9c85 Specify that application services receive events in the CSAPI format
Fixes https://github.com/matrix-org/matrix-doc/issues/1269

This is also supposed to fix the 'age' problem, however that is a larger problem with the event schemas that is reserved for a future PR/commit.
Reference: https://github.com/matrix-org/matrix-doc/issues/1294
Reference: https://github.com/matrix-org/matrix-doc/issues/1524
6 years ago
Travis Ralston bbd33c1461 Move appservice transaction API to the right section
Part of https://github.com/matrix-org/matrix-doc/issues/1532
6 years ago
Travis Ralston 7ec3cc4343 General improvements to the push rules module
This commit does a few things:
* Add 3 undocumented push rules to the spec for encrypted events and at-room notifications.
* Require unrecognized conditions to not match, ensuring that future conditions do not cause clients to accidentally notify users.
* Clarify that push rules should be enabled when created.
* Document a new condition required for at-room notifications.

Fixes https://github.com/matrix-org/matrix-doc/issues/1163
Fixes https://github.com/matrix-org/matrix-doc/issues/1034
Fixes https://github.com/matrix-org/matrix-doc/issues/676
Fixes https://github.com/matrix-org/matrix-doc/issues/1033
Relates to https://github.com/matrix-org/matrix-doc/issues/1101
6 years ago
Travis Ralston 3869f68a5c Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions 6 years ago
Travis Ralston 6172d5986a
Merge pull request #1537 from turt2live/travis/as/user-alias-query
Clean up user and alias querying for application services
6 years ago
Travis Ralston e4f5c3d55e
Merge pull request #1518 from turt2live/travis/c2s/create-room-improvements
Add general clarity to the /createRoom endpoint
6 years ago
Travis Ralston 1d7ea314d4
Merge pull request #1482 from turt2live/travis/s2s/presence
Document how presence EDUs work between servers
6 years ago
Travis Ralston e500e2502a Document the maximum value for depth
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1230
6 years ago
Travis Ralston 7e5160c7c2 Merge remote-tracking branch 'matrix-org/master' into travis/as/user-alias-query 6 years ago
Travis Ralston a320c58e42 A path parameter is obviously URL encoded 6 years ago
Travis Ralston 7ad22b2454
Merge pull request #1533 from turt2live/travis/as/general
General/small improvements to the application service API specification
6 years ago
Travis Ralston 8dc6f092ef Define the type of the power_level_content_override field 6 years ago
Travis Ralston 7e6ca5fef8 Take out the room_alias response field
The argument is that this isn't really needed at this time.
6 years ago
Travis Ralston 1fd7c99461 Clarify that the creation event can have other keys in it 6 years ago
Travis Ralston 6c7a93d2f5 Move description about which preset to use when none is specified 6 years ago
Travis Ralston 7d14309b63 Move the power level event schema to where it was 6 years ago
Travis Ralston c8ba2e098c Wording improvements for appservices 6 years ago
Travis Ralston 8b65da1cf6 Don't try and be fancy about titles 6 years ago
Travis Ralston e712466dca Improve description for currently_active 6 years ago
Valentin Deniaud 10c3307427 document device_one_time_keys_count in /sync/ response
fix #1157
6 years ago
Valentin Deniaud 8afc82c14b fix /keys/claim request example
It didn't correspond to the example response.
6 years ago
Valentin Deniaud ab3272045e add missing v1 to m.olm in /keys/upload 6 years ago
Travis Ralston 60b8e72a67 Minor text changes to the query APIs; Keep OpenMarket copyright
The bulk of these APIs were copied from OpenMarket's work - we should preserve the copyright header.
6 years ago