bundesAPI / bundesAPI/api-doc-template
OpenAPI Check Workflow (Annotations) not working correctly
- Lingua principale
- HTML
- Stelle
- 6
- Fork
- 4
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
The [OpenAPI check](https://github.com/bundesAPI/api-doc-template/blob/main/.github/workflows/openapi_check.yaml) is currently not working correctly.
The annotations which show warnings or errors for the openapi file are sometimes not added at all or sometimes just added to another workflow run.
See: https://github.com/stoplightio/spectral-action/issues/646
Maybe we have to fix the action by ourself since it looks like stoplight does not work on the github action anymore.
We should also think about testing both (or all) openapi files if they exist.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Direzione di ricerca
Start with .github/workflows/openapi_check.yaml and compare its behavior with the linked stoplightio/spectral-action issue #646. Confirm how annotations are attached to workflow runs, then verify that warnings and errors appear on the correct run and that both or all OpenAPI files are checked when present.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- github-actions, yaml
- Ambito
- api, ci-cd
- Tipo di issue
- Bug
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100