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.

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

Don't mention that GET /_matrix/client/v3/profile/{userId} can return additional properties because this is true for almost every endpoint #1910

Merged

Conversation

Johennes
Copy link
Contributor

@Johennes Johennes commented Jul 18, 2024

The endpoint is documented as:

This API may return keys which are not limited to displayname or avatar_url.

This is superfluous though because its true for pretty much every endpoint and calling it out only here can be irritating.

The response schema doesn't include additionalProperties though and, thus, no <Other properties> row is rendered.

This pull requests requires #1909 for the change to be visible in the rendered spec.

Pull Request Checklist

Preview: https://pr1910--matrix-spec-previews.netlify.app

…file/{userId}

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
@Johennes Johennes marked this pull request as ready for review July 18, 2024 07:38
@Johennes Johennes requested a review from a team as a code owner July 18, 2024 07:38
@Johennes
Copy link
Contributor Author

Johennes commented Jul 18, 2024

Converting to draft until @zecakeh's comment in #1909 is resolved.

@Johennes Johennes marked this pull request as draft July 18, 2024 09:19
@Johennes
Copy link
Contributor Author

This now uses additionalProperties: {} in accordance with #1909 on which it no longer depends.

@Johennes Johennes marked this pull request as ready for review July 23, 2024 11:30
@Johennes Johennes changed the title Add additionalProperties in response schema of /_matrix/client/v3/profile/{userId} Don't mention that GET /_matrix/client/v3/profile/{userId} can return additional properties because this is true for almost every endpoint Jul 25, 2024
@Johennes Johennes requested a review from richvdh July 25, 2024 10:04
Copy link
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@richvdh richvdh merged commit 5d91b62 into matrix-org:main Jul 30, 2024
12 checks passed
@zecakeh zecakeh mentioned this pull request Sep 5, 2024
41 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants