OpenAPI file structure for Stoplight documentation
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- openapi, yaml
- Ambito
- api, documentation
Direzione di ricerca
L’issue non nomina file né test. Inizia esaminando l’attuale struttura YAML di Stoplight/OpenAPI e le definizioni API di CDS Events, Curb e Metrics; il lavoro è completato quando ogni API ha il proprio file YAML e tutti i modelli condivisi sono referenziati in modo coerente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Is your feature request related to a problem? Please describe.
When we are building out the OpenAPI files within Stoplight, I believe we need to align on how we should structure the YAML files.
- Option A: 1 YAML file for all of the CDS APIs
- Option B: 1 YAML file for each of the CDS APIs
Describe the solution you'd like
I would like to pursue Option B which is the creation of a YAML file for each of the CDS APIs (Events, Curb, Metrics). This could make the documentation modular and easier to digest when being displayed through Stoplight.
Is this a breaking change
This isn't a breaking change since we have yet to finalize a full Open API version on our documentation
Impacted Spec
All APIs are impacted with this documentation standard.
Describe alternatives you've considered
We would want to use Stoplight to create shared models that can be referenced by multiple APIs if these are needed. This proposed structure does not conflict with previous decisions to maintain a single branch for each API version.
Additional context
Several members of the CDS WGSC collectively showed support for the option to move towards a model where 3 distinct files were used to document each API in the Oct 11th WGSC meeting.
- Lingua principale
- JavaScript
- Stelle
- 7
- Fork
- 0
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di openmobilityfoundation/cds-openapi
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
-
TODO: Update the text table for event_purpose.yamlForse di nuovo libera @michael-danko-passport l’ha presa 1154 giorni fa e non c’è nessuna pull request aperta. Aperta
openmobilityfoundation/cds-openapi#7 · 1 commento · 1 assegnatario ·
-
Implement 501 status codeAperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 32/100
openmobilityfoundation/cds-openapi#2 · 1 commento ·
Tutte le issue di openmobilityfoundation/cds-openapi
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 66/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
pedroapfilho/localveil#120 ·
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
ImpactMojo/ImpactMojo#1385 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
Seeed-Studio/wiki-documents#5974 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno