57f0c8346f
message_pagination.yaml: more $ref cleanup
4 years ago
d3b41941aa
key_backup.yaml: make body parameters required
...
Along the same lines as c72d3051
4 years ago
8e7c0dfb93
Merge remote-tracking branch 'origin/master' into kitsune/cleanup
4 years ago
49ccfa09a8
Merge pull request #2592 from matrix-org/kitsune/fix-room-versions
...
capabilities.yaml: drop an extraneous title
5 years ago
f632f4a20f
Clarify link to OpenID Connect specification ( #2605 )
...
OpenID Connect and OpenID are different things. This seems to be talking about
the former.
5 years ago
29f23a5eda
Merge pull request #2599 from matrix-org/travis/typos
...
Fix typos and clarify the user ID in login sections
5 years ago
cf37688b7c
Merge pull request #2387 from uhoreg/key_backup_spec
...
initial version of spec for key backups
5 years ago
a36284810d
more clarifications and fixes
5 years ago
d9a1de1d30
Fix typos and clarify the user ID in login sections
5 years ago
40c50c80ea
Apply suggestions from code review
...
Co-authored-by: Travis Ralston <travpc@gmail.com>
5 years ago
bda05a0d44
capabilities.yaml: drop an extraneous title
...
AvailableRoomVersions sticks itself as a property type, preempting
the mention of RoomVersionStability in the generated text.
5 years ago
3b5340539d
c2s: Make allOf and description siblings throughout the PR
...
The overall mess with allOf will be addressed separately; this PR just
puts $ref under allOf to fix the glaring misuse of $ref objects.
5 years ago
48af2e5b47
joining.yaml: put descriptions next to their properties
...
Fixing the problem described in https://github.com/matrix-org/matrix-doc/pull/2518#issuecomment-621684187
5 years ago
040a91f42d
api/: More cleanup in descriptions
...
(and a fix in one example).
5 years ago
67a8176903
Clarify officially that we use multiple API files
...
This is not something endorsed by the OpenAPI spec, just our practice.
5 years ago
6cfb94562e
c2s: clean up $ref objects
...
* Most of the changes: align to the $ref object definition
(https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03#section-3 )
that says that any attribute other than $ref be ignored.
* Remove extraneous leading ./ in $ref paths
* Fix an apparent typo in registration.yaml:
/account/password/msisdn/requestToken used a file from ../identity/*
instead of its c2s namesake.
5 years ago
db72e7caea
Merge pull request #2575 from matrix-org/travis/clarification/send-join
...
Clarify the auth_chain and state requirements for /send_join
5 years ago
c3289614da
Merge pull request #2562 from matrix-org/travis/spec/2432-alias-semantics
...
Add spec for new alias handling (client-server)
5 years ago
04a26dafd0
Merge pull request #2546 from matrix-org/travis/spec/1466-softlogout
...
Spec soft-logout per MSC1466
5 years ago
a5cb9c655c
It's important to say who
...
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
5 years ago
bea6b321a5
Change the nots order
...
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
5 years ago
9bdafab2a4
Merge pull request #2571 from matrix-org/travis/clarification/createRoom-events
...
Clarify that a creation event and member event are needed for createRoom
5 years ago
669377888e
Fix more typos throughout the specification
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2193
5 years ago
67d46fa881
Clarify the auth_chain and state for send_join
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2467
Fixes https://github.com/matrix-org/matrix-doc/issues/2464
This is based on looking at Synapse, not actually testing it. Within the send_join handling functions, an "event context" is acquired [here](d14c4d6b6d/synapse/handlers/federation.py (L1472)d14c4d6b6d/synapse/state/__init__.py (L286-L289)d14c4d6b6d/synapse/handlers/federation.py (L1494-L1501)d14c4d6b6d/synapse/state/__init__.py (L351)
5 years ago
c72d30513e
c2s: Add required: true to request bodies
5 years ago
06b0c1762a
Move the send_join response to its own definition
...
Both APIs need clarification, so dedupe the changes.
We should also probably deprecate some of this stuff so we can eventually remove it.
5 years ago
200212ffd7
Clarify that a creation event and member event are needed for createRoom
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2494
5 years ago
36ed6e94a2
Re-introduce signature schemas
5 years ago
6a8ba9b1d6
improve description of key object in CS and include a link in Fed
5 years ago
5b38c04e19
make definition of signatures fields more consistent
5 years ago
12ecf9f383
Merge pull request #2561 from matrix-org/travis/doc-2xx-format
...
Mention that we use OpenAPI 3's response code format
5 years ago
b11cf560b5
Add spec for new alias handling (client-server)
...
MSC: https://github.com/matrix-org/matrix-doc/pull/2432
This commit does not deal with areas which will be covered by the room version specifications (namely the redaction algorithm).
It feels a bit overly cruel to completely obliterate all mentions of `m.room.aliases` from the spec as client/server developers may encounter the event type in the wild. To ensure that CTRL+F still works, a brief mention that they do nothing has been put in place, leaving no other references (except the redaction algorithm - see previous paragraph).
5 years ago
1388742a52
Mention that we use OpenAPI 3's response code format
...
See comments of https://github.com/matrix-org/matrix-doc/pull/2238
5 years ago
74b627ac0b
Fix the response format of the `/send` endpoint
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2236
5 years ago
fc91946e5a
Update api/server-server/backfill.yaml
...
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
5 years ago
9765116c47
Make backfill wording clearer
5 years ago
05e83f2e7d
Fix more describes -> describe
5 years ago
0e771c7b07
Merge pull request #2547 from matrix-org/travis/spec/1802-fix-200
...
Spec v2 send_join and send_leave endpoints
5 years ago
7c0046ffc7
describes -> describe
5 years ago
d419e3b38a
Remove extraneous spaces
5 years ago
28d460fb62
Fix Typo
5 years ago
a2a1694c35
Spec v2 send_join and send_leave endpoints
...
MSC: https://github.com/matrix-org/matrix-doc/pull/1802
Fixes https://github.com/matrix-org/matrix-doc/issues/2541
This also adds the v2 invite endpoint to the ACL protected list as that appears to be an omission.
5 years ago
d24f15a3a9
Spec soft-logout per MSC1466
...
MSC: https://github.com/matrix-org/matrix-doc/issues/1466
5 years ago
fae1165e1c
spec what to do if you try to delete a backup that's already deleted
5 years ago
bd95568c8c
remove duplicate key
5 years ago
1bae8ea633
we actually don't support the GET /room_key/versions/ with trailing slash
5 years ago
42ae5c966a
Clarify the limits of prev_events and auth_events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2307
These restrictions are due to a Synapse change which never made it to the spec prior to the MSC process. This is therefore documenting an omission.
Synapse's numbers are verified here: 207b1737ee/synapse/handlers/federation.py (L1183-L1213)207b1737ee/synapse/handlers/federation.py (L829-L837)https://github.com/matrix-org/matrix-doc/pull/1594 should render the `auth_events` limitation unnecessary.
No changes are required to the the "checks on receipt of a PDU" section of the server-server spec as it starts with "must be a valid event", to which an event is invalid if it contains too many prev or auth events.
5 years ago
ff59fc1905
/keys/query: Add a title in the response
...
The device keys structure in queryKeys is not the same as the one
defined in device_keys.yaml (it adds things on top of it).
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
5 years ago
77783b8fc3
Remove extraneous quotes, fix a typo
...
filter.yaml: quotes under |- were taken literally.
notifications.yaml: it's a number in the example, not a string
5 years ago
a896729ac2
some more clarifications and indentation fixes
5 years ago
Kitsune Ral