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

Should we allow multiple path segments or @key properties in a model definition? #160

Open
markcowl opened this issue Jan 10, 2022 · 3 comments
Labels
design:needed A design request has been raised that needs a proposal
Milestone

Comments

@markcowl
Copy link
Contributor

markcowl commented Jan 10, 2022

This came up as part of #110

Currently, multiple path segments designated on a model is disallowed. Is there a need to allow multiple path segments for a key:

  • For composite keys (i.e. when there are multiple keys, but no parent resource)
    • possible example: Compute VM Gallery
    • How do we express ordering in the path segments without a route string (for autoroute)?
  • If there are alternate paths to accessing the resource
    • this is a common pattern for ODATA APIs

Additionally, should we separate '@key' from path segments, and should we allow multiple `@key' properties in a model

  • This comes up in arrays of complex types. The 'id' of a particular instance may be made up of multiple properties (e.g. firstName, lastName)
    • should we allow this
    • Is there any important ordering in keys (last name, first name, for example) that we want to preserve?
@markcowl markcowl added the design:needed A design request has been raised that needs a proposal label Jan 10, 2022
@markcowl markcowl added this to the Backlog milestone Jan 10, 2022
@markcowl markcowl changed the title Should we allow multiple @key properties in a model definition? Should we allow multiple path segments or @key properties in a model definition? Feb 23, 2022
@markcowl markcowl self-assigned this Mar 28, 2022
@markcowl markcowl modified the milestones: Backlog, [2022] May Apr 12, 2022
@markcowl markcowl modified the milestones: [2022] May, Backlog May 11, 2022
@markcowl markcowl modified the milestones: Backlog, [2023] June May 1, 2023
@markcowl markcowl modified the milestones: [2023] June, Backlog Jun 6, 2023
@markcowl markcowl removed their assignment Jun 6, 2023
@markcowl markcowl modified the milestones: Backlog, [2023] December Nov 6, 2023
@markcowl
Copy link
Contributor Author

markcowl commented Nov 7, 2023

potential solutions

  • empty parent resource

@markcowl
Copy link
Contributor Author

markcowl commented Nov 7, 2023

Thgis sprint:

    • links to specs with this issue

@markcowl markcowl modified the milestones: [2023] December, Backlog Nov 7, 2023
@markcowl markcowl self-assigned this Nov 7, 2023
@markcowl markcowl modified the milestones: Backlog, [2023] December Nov 7, 2023
@markcowl markcowl removed their assignment Jan 29, 2024
@markcowl
Copy link
Contributor Author

Need to collect data on how many specs would benefit from this

@markcowl markcowl modified the milestones: [2024] February, [2024] April Feb 7, 2024
@markcowl markcowl modified the milestones: [2024] April, [2024] May, Backlog Apr 6, 2024
@bterlson bterlson removed the 📌 label May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design:needed A design request has been raised that needs a proposal
Projects
None yet
Development

No branches or pull requests

3 participants