Use annotation from the model to create OpenApiInfo
還沒有人認領這個 Issue。
評估
研究方向
先檢查主要 schema 對 Core.Description 和 Core.SchemaVersion 的 ODL 支援,然後檢視目前的 OpenApiInfo 產生流程。支援這些註解後,使用它們設定標題、版本和描述;如果沒有註解,則保留預設值。
由索引模型根據 Issue 內容生成。
描述
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.
- 主要語言
- C#
- 星號
- 240
- 分支
- 70
- 平均合併
- 7 小時 59 分鐘
- 30 天內合併 PR
- 13
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
microsoft/OpenAPI.NET.OData 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 68/100
microsoft/OpenAPI.NET.OData#661 ·
-
難度 3/5 1-2 天 新手友好度 58/100
microsoft/OpenAPI.NET.OData#852 ·
-
難度 4/5 3-5 天 新手友好度 45/100
microsoft/OpenAPI.NET.OData#833 ·
-
status:needs-more-information
難度 4/5 3-5 天 新手友好度 42/100
microsoft/OpenAPI.NET.OData#723 · 1 則留言 · 1 個 reaction ·
-
難度 3/5 1-2 天 新手友好度 45/100
microsoft/OpenAPI.NET.OData#720 ·
查看 microsoft/OpenAPI.NET.OData 的全部 Issue
相似的 Issue
-
type/automation type/tech-debt
難度 2/5 1-3 小時 新手友好度 78/100
-
bug
難度 2/5 1-3 小時 新手友好度 88/100
-
t/bug
難度 2/5 1-3 小時 新手友好度 82/100
-
ci-failure-cause test-failure
難度 2/5 1-3 小時 新手友好度 82/100
-
area:auth FE mvp P3
難度 2/5 1-3 小時 新手友好度 88/100
klasolsson81/jobbliggaren#1788 ·