OAI / OAI/OpenAPI-Specification

Feature request: standard file that describes what openapi features are supported by an implementation

Aperta
#3,247 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
Markdown
Stelle
31.2k
Fork
9.2k
Merge medio
6h 37m
PR unite (30g)
27

Descrizione

Feature request: standard file that describes what openapi features are supported by an implementation

If all implementations provided a yaml or json file of what features were supported it would allow for easier comparison of implementations.

What if we did this with the json schema descriptions of the openapi spec:
https://github.com/OAI/OpenAPI-Specification/blob/main/schemas/v3.0/schema.yaml

And the json path was the feature, like:
#/servers and the value is a boolean or a FeatureSupportInfo object like so:

FeatureSupportInfo:
  type: object
  properties:
    supported:
      type: boolean
    docUrl:
      type: string
    verificationTestUrl:
      type: string
  required:
  - supported

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.

Direzione di ricerca

Inizia esaminando lo schema OpenAPI v3.0 schema.yaml collegato nell’issue e la proposta per i percorsi delle funzionalità JSON Pointer. Chiarisci l’ambito e il formato con i maintainer prima dell’implementazione. Il lavoro è completato quando il repository dispone di uno standard concordato per descrivere le funzionalità supportate, inclusi link opzionali alla documentazione e alla verifica.

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

Valutazione

Stack tecnologico
json, openapi, yaml
Ambito
api
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.