Skip to content

Use annotation from the model to create OpenApiInfo #2

@xuzhg

Description

@xuzhg

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.

Metadata

Metadata

Labels

blockeddependency:odataOData lib dependencypriority:p3Nice to have. Customer impact is very minimalstatus:waiting-for-dependencyAn issue that has core project dependency that's currently blocking ittype:enhancementEnhancement request targeting an existing experience.

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions