Commit Graph

66 Commits (62b9154fa7b021df75ace0c80b684ed2a27b254d)

Author SHA1 Message Date
Kitsune Ral 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.
4 years ago
Kitsune Ral 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.
4 years ago
Kitsune Ral c72d30513e c2s: Add required: true to request bodies 4 years ago
Travis Ralston e95eafb2ba Clarify that submit_url is without authentication
The request is authorized by its parameters, not by an additional access token.

Fixes https://github.com/matrix-org/matrix-doc/issues/2298
5 years ago
Travis Ralston 2bca44a2e5 Remove extraneous backwards compatibility note 5 years ago
Travis Ralston f5f12a29e0 Spec MSC2290: 3PID binding split 5 years ago
Travis Ralston 48b8a95df6 Deprecate id_server and make it optional
As per [MSC2263](https://github.com/matrix-org/matrix-doc/pull/2263)
5 years ago
Travis Ralston 642be6c677 Fix unbind wording 5 years ago
Travis Ralston 30a9de7e02 Merge branch 'master' into travis/spec/is-unbind 5 years ago
Travis Ralston 1881a255c2 Clarify that id_access_token is optional for r0.5 5 years ago
Travis Ralston 185c564a13 Spec client-server IS unbind API
As per [MSC2140](https://github.com/matrix-org/matrix-doc/pull/2140)

Note: this modifies the endpoint in MSC2140 to be more in line with the remainder of the proposal.
5 years ago
Travis Ralston 001c51a740 /3pid/delete and /deactivate don't take an id_access_token 5 years ago
Travis Ralston 0408373cf9 Litter the client-server API with id_access_token 5 years ago
Travis Ralston b8f1f37927 Remove incorrect id_server param from IS spec
Fixes https://github.com/matrix-org/matrix-doc/issues/2118
5 years ago
Travis Ralston 56745c76aa Clarify that submit_url being not present only matters for r0.5 5 years ago
Travis Ralston ca8b539b2f humans prefer to be treated as people 5 years ago
Andrew Morgan 2068cba598 Clients should submit a POST request 5 years ago
Andrew Morgan d1fde0837a Consolidate id_server into ref. id_server/next_link are ignored 5 years ago
Andrew Morgan ab0c1bc054 Add changelog, update imperative check, rename sid.yaml 5 years ago
Andrew Morgan fe23de7d7f A SMS -> An SMS 5 years ago
Andrew Morgan 046a834488 Slight code cleanup 5 years ago
Andrew Morgan 525bedf8e1 Fix refs 5 years ago
Andrew Morgan fba61941af Move submit_url responses to ref 5 years ago
Andrew Morgan 0ded484276 Address review comments 5 years ago
Andrew Morgan 1776ba28d3 Address review comments 5 years ago
Andrew Morgan 8a6ef187db more object! 5 years ago
Andrew Morgan 62910a28cc Merge branch 'master' into anoa/hs_3pid_tokens
* master:
  Update example
  Fix 404s in links from room v1 spec
  Provide a more complete example of a "minimally-sized event"
  Revert signature change for redactable event test
  Clarify how many PDUs are in a given transaction object
  Clarify that the server shouldn't process retries for UIA
  Clarify when authorization and rate-limiting are not applicable
  Skip over partial event definitions in examples
  Rename example to invite_room_state
  Shorten references to StrippedState in s2s spec
  Fix examples of StrippedState in s2s spec
  Clarify exactly what StrippedState is
  Clarify that UIA stages cannot be attempted twice
  Fix test vectors with invalid JSON and signature
  Spec 3PID unbind API
  Spec MSISDN UIA support
5 years ago
Andrew Morgan 3148184052 HS' can send 3PID token. Add a new submit_url field 5 years ago
Travis Ralston 0463084924 Spec 3PID unbind API
As per [MSC1915](https://github.com/matrix-org/matrix-doc/pull/1915)

Implementation proof: 
* https://github.com/matrix-org/synapse/pull/4982
* https://github.com/matrix-org/sydent/pull/160

The only alteration made which differs from the proposal is clarity on how to handle homeservers not knowing the `id_server`. All other differences are unintentional.
5 years ago
Konstantinos Sideris 192a6c2ab9 Use example.org on examples instead of domain.com which is a real domain
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
6 years ago
Travis Ralston 7d34995ece It's actually an "identity server implementing the Identity Service API"
Also add a note about appservices being special.
6 years ago
Travis Ralston 7ac76fa27c Actually we're going with "identity server" afterall 6 years ago
Travis Ralston ec248b436f Identity Service is lowercase 6 years ago
Travis Ralston cc0badaaa1 Fix all naming cases of "identity service"
Fixes https://github.com/matrix-org/matrix-doc/issues/1396

Includes some "homeserver" fixes too. This commit does not include historical documentation or notes.
6 years ago
Travis Ralston 1261da209d Fix wording for the homeserver not allowing a particular 3pid 6 years ago
Travis Ralston 824ce22caa Add additional clarity to the requestToken errors 6 years ago
Travis Ralston 5bb7eca8e8 English 6 years ago
Travis Ralston 60dd9231e0 Don't explain how the IS might accept a 3pid
The IS is bound to it's own set of specifications, and if the client chose this API then they should be aware of the risks but not necessarily arbitrary alternatives.
6 years ago
Travis Ralston 63fdd72f73 Fix error description on /account/3pid/email/requestToken 6 years ago
Travis Ralston a4c2b2b905 General clarity and spelling for the requestToken APIs 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 5da3072eef Wording change ('may not' has a special meaning) 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 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
Hubert Chathi f5dc0eaed2
document msisdn-related endpoints in IS (#1507)
* add msisdn endpoints in Identity Server spec
* add in CS endpoints that use the IS msisdn endpoints
6 years ago
Travis Ralston caa6d4d9ad Give all errors a schema reference
This just helps keep an overall structure
6 years ago
Kitsune Ral 24afe7987c Add operationId to all endpoints of all APIs
To facilitate generation of API stubs from the spec.

Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
7 years ago
Richard van der Hoff 820704a16a Format examples as raw objects
According the the openapi spec, examples for responses and schemas should be
raw objects rather than being json strings. (It's unclear what non-json
examples should look like...).

The swagger UI used to support json strings, but no longer does. In short,
let's turn the json strings into their raw formats.
7 years ago