Skip to content

Added schemata-API's without locations #600

Open
erwinspeybroeck wants to merge 4 commits intoDevelopfrom
erwinspeybroeck
Open

Added schemata-API's without locations #600
erwinspeybroeck wants to merge 4 commits intoDevelopfrom
erwinspeybroeck

Conversation

@erwinspeybroeck
Copy link
Copy Markdown
Collaborator

issue #594 #594

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds location-independent schemata endpoints to the URL scheme OpenAPI example to address #594, while keeping the existing location-scoped variants.

Changes:

  • Introduces global schemata endpoints: GET /schemata, GET /schemata/{scheme-type}, and GET /schemata/{scheme-type}/{scheme}.
  • Re-adds/keeps the existing location-scoped schemata endpoints and renames their operationIds to be location-specific (e.g., get-location-schema-types).
  • Updates the paths section structure to include both global and location-scoped schemata routes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@cookeac cookeac linked an issue Apr 10, 2026 that may be closed by this pull request
Copy link
Copy Markdown
Collaborator

@cookeac cookeac left a comment

Choose a reason for hiding this comment

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

I have requested a CoPilot review and merged in the corrections that it suggested (mainly description changes). I did wonder whether it was the right thing to do, to change the existing API's operationIds to have the word "location" and reuse the operationIds on the new APIs, or whether we should have given the new API "location-independent" operationIds. I don't have a strong opinion, but wondered about code generation impacts for existing users.

Copy link
Copy Markdown
Collaborator

@AlexeyHardCode AlexeyHardCode left a comment

Choose a reason for hiding this comment

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

Image Looks very good, thanks @erwinspeybroeck. One comment on the description: should it differ between the variants with and without location? Currently, both are the same. The usage is quite clear, but it could be useful to clarify why both versions exist. What do you think?

@AlexeyHardCode
Copy link
Copy Markdown
Collaborator

I have requested a CoPilot review and merged in the corrections that it suggested (mainly description changes). I did wonder whether it was the right thing to do, to change the existing API's operationIds to have the word "location" and reuse the operationIds on the new APIs, or whether we should have given the new API "location-independent" operationIds. I don't have a strong opinion, but wondered about code generation impacts for existing users.

Good point, @cookeac. I’d avoid renaming existing items.
operationId maps to the generated controller method name, but it doesn’t affect routes or runtime behavior. The main risk is breaking internal references (e.g., tests).
So it’s preferable to keep it unchanged if possible.

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.

The schemata API's - do they need the location en location scheme?

4 participants