Reorganize client authentication section to separate the legacy API and the new OAuth 2.0 API#2141
Conversation
Since account locking and suspension are authentication API agnostic, this is a pre-requisite to adding the new OAuth 2.0-based API. This also splits the endpoints that where all included in the registration OpenAPI data, to separate them cleanly in the spec, and avoid having deactivation show before registration. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
cf45f4d to
c68a87c
Compare
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
| @@ -0,0 +1 @@ | |||
| Add the OAuth 2.0 based authentication API, as per [MSC3861](https://github.com/matrix-org/matrix-spec-proposals/pull/3861) and its sub-proposals. | |||
There was a problem hiding this comment.
My guess is that we will use this changelog for most of the PRs related to the OAuth 2.0 API.
| {{% /boxes/note %}} | ||
|
|
||
| #### Example | ||
| **Example** |
There was a problem hiding this comment.
I downgraded this to a non-heading, because I feel like it doesn't need to appear in the ToC.
| ``` | ||
|
|
||
| ##### Example | ||
| **Example** |
There was a problem hiding this comment.
Same here, I downgraded this to a non-heading, because I feel like it doesn't need to appear in the ToC.
richvdh
left a comment
There was a problem hiding this comment.
Looks like a good start to me.
I think we should add a {{% added-in %}} for the OAuth 2.0 API, and probably a {{% changed-in %}} for the legacy one. And obviously at some point we'll need to add text explaining the relationship between the two APIs. But it sounds like maybe you're planning that for after some of the other PRs have landed?
I'm happy to land this as-is if you want to delay those tasks. What do you think?
|
Yes I was thinking of writing more in a separate PR to be able to merge this as quickly as possible to avoid blocking other PRs. I definitely plan to add more context around those APIs. |
This is supposed to be a PR on which other PRs that add bits of the OAuth 2.0 API will be based. As such it separates the sub-sections that are specific to the legacy API in its own section, and it adds an empty "OAuth 2.0 API" section.
Since account locking and suspension are authentication API agnostic, this also adds a new "Account moderation" section.
This also splits the "Account registration and management" section and its endpoints to separate them cleanly in the spec, for 2 reasons:
The plan for the future is:
Pull Request Checklist
Preview: https://pr2141--matrix-spec-previews.netlify.app