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

[2.0] OpenAPI Annotation Attributes #660

Open
Tiberriver256 opened this issue Dec 10, 2019 · 1 comment
Open

[2.0] OpenAPI Annotation Attributes #660

Tiberriver256 opened this issue Dec 10, 2019 · 1 comment
Labels
Milestone

Comments

@Tiberriver256
Copy link

Feature

As a developer making a RESTier API I would like automated OData annotations so that my API consumers can more easily use the API

Scenario:
Given the Id property of an entity is designated with the [Key] attribute
When the $metadata is called
Then the property should have the computed=true attribute

For a nice list of properties that are pretty common / standard check out the annotations that the odata to openapi conversion tool supports:
https://github.com/oasis-tcs/odata-openapi/blob/master/doc/Annotations.md

Starting with adding support for the computed and the description attribute would be sufficient for most scenarios

@robertmclaws robertmclaws added this to the 2.0 milestone Dec 12, 2019
@robertmclaws
Copy link
Collaborator

Let's research how Microsoft's OData to OpenAPI library works and see if we can't add the ability to add attributes to your model and have them automatically show up in the metadata for OpenAPI.

@robertmclaws robertmclaws changed the title Feature Request: Automated OData Annotations [2.0] OpenAPI Annotation Attributes Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: No status
Development

No branches or pull requests

2 participants