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

Fix bookmarks creation endpoint #7055

Merged
merged 1 commit into from Apr 29, 2024
Merged

Conversation

adriansmares
Copy link
Contributor

Summary

References #6483

In short, /users/bookmarks can be interpreted as a request towards the user called bookmarks. The only reason why this doesn't happen is that methods don't overlap - bookmark creation uses POST while user updates require PUT.

The API itself is very hierarchical - sub-entities generally contain the top level entity ID in the path in order to avoid these possible path overlaps, and this should apply here as well.

Changes

  • Ensure that UserRegistry HTTP paths do not overlap with UserBookmarkRegistry HTTP paths.

Testing

N/A. This just changes the generated code. No testing required.

Regressions

N/A. The Console does not depend on this feature, and the CLI clients are unaffected as they use gRPC.
It may be tempting to say that this API has already been released and is frozen, but there are no real clients for it, so it's better to fix this now than later.

Checklist

  • Scope: The referenced issue is addressed, there are no unrelated changes.
  • Compatibility: The changes are backwards compatible with existing API, storage, configuration and CLI, according to the compatibility commitments in README.md for the chosen target branch.
  • Documentation: Relevant documentation is added or updated.
  • Testing: The steps/process to test this feature are clearly explained including testing for regressions.
  • Infrastructure: If infrastructural changes (e.g., new RPC, configuration) are needed, a separate issue is created in the infrastructural repositories.
  • Changelog: Significant features, behavior changes, deprecations and fixes are added to CHANGELOG.md.
  • Commits: Commit messages follow guidelines in CONTRIBUTING.md, there are no fixup commits left.

@adriansmares adriansmares added this to the v3.30.1 milestone Apr 29, 2024
@adriansmares adriansmares marked this pull request as ready for review April 29, 2024 10:39
@adriansmares adriansmares requested a review from a team as a code owner April 29, 2024 10:39
Copy link
Contributor

@nicholaspcr nicholaspcr left a comment

Choose a reason for hiding this comment

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

Good catch.

@adriansmares adriansmares merged commit bc0a0c5 into v3.30 Apr 29, 2024
15 of 16 checks passed
@adriansmares adriansmares deleted the fix/create-bookmark-path branch April 29, 2024 14:42
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