Use annotation from the model to create OpenApiInfo

Aperta
#2 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
csharp
Ambito
api

Direzione di ricerca

Inizia esaminando il supporto di ODL per Core.Description e Core.SchemaVersion nello schema principale, quindi esamina la generazione attuale di OpenApiInfo. Una volta supportate queste annotazioni, usale per il titolo, la versione e la descrizione, mantenendo i valori predefiniti quando le annotazioni sono assenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

blocked dependency:odata priority:p3 status:waiting-for-dependency type:enhancement

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.

Lingua principale
C#
Stelle
240
Fork
70
Merge medio
7h 59m
PR unite (30g)
13

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di microsoft/OpenAPI.NET.OData

Tutte le issue di microsoft/OpenAPI.NET.OData

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.