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

Annotate constructor/factory actions #297

Closed
ralfhandl opened this issue Mar 20, 2024 · 2 comments
Closed

Annotate constructor/factory actions #297

ralfhandl opened this issue Mar 20, 2024 · 2 comments
Assignees
Labels
Protocol Protocol, URL Conventions V4.02 Vocabularies

Comments

@ralfhandl
Copy link
Contributor

In 11.5.4.1 Invoking an Action we define that

Actions that create and return a single entity follow the rules for entity creation and return a Location header that contains the edit URL or read URL of the created entity.

Currently there's no way for clients and generic tools to recognize such "constructor" or "factory" actions. Annotating these actions would be helpful for e.g. OpenAPI generation from $metadata.

Proposal

Add tagging term Core.Constructor

<Term Name="Constructor" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Action">
  <Annotation Term="Core.Description" String="The annotated action constructs new entities" />
</Term>

Imported from ODATA-1214

@ralfhandl
Copy link
Contributor Author

Both related pull requests have been merged, the only left-over is merging PR oasis-tcs/odata-vocabularies#239 once V4.02 CS01 is published

@mikepizzo
Copy link
Contributor

Closed 2024-3-4 as PRs have been created.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Protocol Protocol, URL Conventions V4.02 Vocabularies
Projects
Status: Closed
Development

No branches or pull requests

2 participants