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

Spec for MSC3981 #1746

Merged
merged 11 commits into from Mar 19, 2024
Merged

Spec for MSC3981 #1746

merged 11 commits into from Mar 19, 2024

Conversation

dbkr
Copy link
Member

@dbkr dbkr commented Mar 12, 2024

This writes up matrix-org/matrix-spec-proposals#3981

Hopefully this is relatively straightforward, apart from having to add the parameters and response field in all three places. I tried to factor these out but it seems references just aren't supported in the right places currently (see #1745 for my efforts). Path parameters can't be optional, so it can't be done that way either.

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

This writes up matrix-org/matrix-spec-proposals#3981

Hopefully this is relatively straightforward, apart from having to add
the parameters and response field in all three places. I tried to factor
these out but it seems references just aren't supported in the right
places currently (see #1745
for my efforts). Path parameters can't be optional, so it can't be done
that way either.
@dbkr dbkr marked this pull request as ready for review March 12, 2024 17:50
@dbkr dbkr requested a review from a team as a code owner March 12, 2024 17:50
@richvdh
Copy link
Member

richvdh commented Mar 13, 2024

I think I've fixed #1745, so let's hang fire hire for a minute

@richvdh richvdh marked this pull request as draft March 13, 2024 13:53
@dbkr
Copy link
Member Author

dbkr commented Mar 19, 2024

Updated with ref version

@dbkr dbkr marked this pull request as ready for review March 19, 2024 17:20
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.

a few nits but lgtm otherwise

data/api/client-server/relations.yaml Outdated Show resolved Hide resolved
data/api/client-server/relations.yaml Outdated Show resolved Hide resolved
data/api/client-server/relations.yaml Outdated Show resolved Hide resolved
content/client-server-api/_index.md Outdated Show resolved Hide resolved
content/client-server-api/_index.md Outdated Show resolved Hide resolved
dbkr and others added 6 commits March 19, 2024 18:02
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Note this is counter what the MSC actually proposed to add, but
I think it's clear that this is what it meant.
@dbkr dbkr merged commit 848c1e0 into main Mar 19, 2024
12 checks passed
@dbkr dbkr deleted the dbkr/msc3981 branch March 19, 2024 18:12
@@ -0,0 +1 @@
Add support for recursion on the /relations endpoints (MSC3981).
Copy link
Member

Choose a reason for hiding this comment

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

I've applied the change to main as part of release checklist steps, but for future PRs please use a consistent changelog style (and apologies if these aren't documented anywhere - we should fix that if undocumented).

  • Use backticks around endpoints, and indicate the request method.
  • Use , as per [MSC3981](...). at the end of your changelog, linking to the MSC in question.
Add support for recursion on the `GET /relations` endpoints, as per [MSC3981](https://github.com/matrix-org/matrix-spec-proposals/pull/3981).

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.

None yet

3 participants