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

Use annotation from the model to create OpenApiInfo #2

Open
xuzhg opened this issue Nov 22, 2017 · 1 comment
Open

Use annotation from the model to create OpenApiInfo #2

xuzhg opened this issue Nov 22, 2017 · 1 comment
Assignees
Labels
blocked dependency:odata OData lib dependency priority:p3 Nice to have. Customer impact is very minimal status:waiting-for-dependency An issue that has core project dependency that's currently blocking it type:enhancement Enhancement request targeting an existing experience.

Comments

@xuzhg
Copy link
Contributor

xuzhg commented Nov 22, 2017

The OASIS OData to OpenApi v3.0 says:

4.2.1 Field title
The value of title is the value of the unqualified annotation Core.Description (see [OData-VocCore]) of the main schema or the entity container of the OData service.
If no Core.Description is present, a default title has to be provided as this is a required OpenAPI field.
4.2.2 Field version
The value of version is the value of the annotation Core.SchemaVersion (see [OData-VocCore]) of the main schema.
If no Core.SchemaVersion is present, a default version has to be provided as this is a required OpenAPI field.
4.2.3 Field description
The value of description is the value of the annotation Core.LongDescription (see [OData-VocCore]) of the main schema or the entity container.
While this field is optional, it prominently appears in OpenAPI exploration tools, so a default description should be provided if no Core.LongDescription annotation is present.

However, the ODL doesn't support "Core.Description" on main schema and Core.SchemaVersion. Once it supports, please update using the annotation.

darrelmiller pushed a commit that referenced this issue Mar 24, 2020
@baywet baywet added the type:enhancement Enhancement request targeting an existing experience. label Nov 23, 2021
@darrelmiller darrelmiller added the priority:p3 Nice to have. Customer impact is very minimal label Mar 1, 2022
@darrelmiller darrelmiller added this to the OData:1.2 milestone Sep 8, 2022
@millicentachieng millicentachieng self-assigned this Sep 8, 2022
@millicentachieng
Copy link
Member

Schema annotations are not included in the resulting EdmModel after parsing the CSDL. Issue raised in the OData lib OData/odata.net#2530

@adhiambovivian adhiambovivian added status:waiting-for-dependency An issue that has core project dependency that's currently blocking it dependency:odata OData lib dependency labels Mar 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked dependency:odata OData lib dependency priority:p3 Nice to have. Customer impact is very minimal status:waiting-for-dependency An issue that has core project dependency that's currently blocking it type:enhancement Enhancement request targeting an existing experience.
Projects
None yet
Development

No branches or pull requests

6 participants