Use resource IDs in REST paths and return full entities from create operations - #240
Open
barreiro wants to merge 1 commit into
Open
Use resource IDs in REST paths and return full entities from create operations#240barreiro wants to merge 1 commit into
barreiro wants to merge 1 commit into
Conversation
barreiro
force-pushed
the
rest-interface
branch
from
August 5, 2026 14:51
9ffd6c3 to
bf7b5ca
Compare
barreiro
force-pushed
the
rest-interface
branch
from
August 5, 2026 15:11
bf7b5ca to
2fba8c7
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
byName()service methods tofind()across all service interfacesMotivation
Name-based resource identifiers in URL paths are fragile: they break if a resource is renamed, require URL-encoding for names with special characters, and couple clients to a mutable attribute instead of a stable surrogate key. Using numeric IDs as path parameters follows REST conventions where URIs identify resources by stable, opaque identifiers (RFC 7231). Names that serve as lookup criteria are better suited as query parameters, which is where folder creation now takes its name.
Returning full entities from mutating operations eliminates the need for clients to issue a follow-up GET after every create, reducing round-trips and making the API more self-contained (per the principle of "respond with the resource representation").