Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow /versions to optionally accept authentication #1728

Merged
merged 3 commits into from
Mar 7, 2024
Merged

Allow /versions to optionally accept authentication #1728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c5074f2
Allow /versions to optionally accept authentication
zecakeh Feb 22, 2024
8ade27c
Add changelog
zecakeh Feb 22, 2024
82d37d8
Set "Requires Authentication: Optional"
zecakeh Mar 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/1728.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Allow `/versions` to optionally accept authentication, as per [MSC4026](https://github.com/matrix-org/matrix-spec-proposals/pull/4026).
21 changes: 17 additions & 4 deletions data/api/client-server/versions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,21 @@ paths:
which has not yet landed in the spec. For example, a feature currently
undergoing the proposal process may appear here and eventually be taken
off this list once the feature lands in the spec and the server deems it
reasonable to do so. Servers may wish to keep advertising features here
after they've been released into the spec to give clients a chance to
upgrade appropriately. Additionally, clients should avoid using unstable
features in their stable releases.
reasonable to do so. Servers can choose to enable some features only for
some users, so clients should include authentication in the request to
get all the features available for the logged-in user. If no
authentication is provided, the server should only return the features
available to all users. Servers may wish to keep advertising features
here after they've been released into the spec to give clients a chance
to upgrade appropriately. Additionally, clients should avoid using
unstable features in their stable releases.
operationId: getVersions
security:
- {}
- accessToken: []
x-changedInMatrixVersion:
"1.10": |
This endpoint can behave differently when authentication is provided.
responses:
"200":
description: The versions supported by the server.
Expand Down Expand Up @@ -89,3 +99,6 @@ servers:
default: localhost:8008
basePath:
default: /_matrix/client
components:
securitySchemes:
$ref: definitions/security.yaml
18 changes: 17 additions & 1 deletion layouts/partials/openapi/render-operation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,23 @@ <h1 id="{{ lower $method }}{{ $anchor }}">
</tr>
<tr>
<th>Requires authentication:</th>
<td>{{ if $operation_data.security }}Yes{{ else }}No{{ end }}</td>
{{/*
zecakeh marked this conversation as resolved.
Show resolved Hide resolved
Authentication is defined with the `security` key. We assume that the
key is not set if no authentication is necessary. If the key is set,
authentication is required unless it contains an item that is an empty
object.
*/}}
{{ $requires_authentication := "Yes" }}
{{ if $operation_data.security }}
{{ range $operation_data.security }}
{{ if eq (len (index $operation_data.security 0)) 0 }}
{{ $requires_authentication = "Optional" }}
{{ end }}
{{ end }}
{{ else }}
{{ $requires_authentication = "No" }}
{{ end }}
<td>{{ $requires_authentication }}</td>
</tr>
</table>

Expand Down
Loading