bundesAPI / bundesAPI/api-doc-template

OpenAPI Check Workflow (Annotations) not working correctly

Ouverte
#6 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
HTML
Étoiles
6
Forks
4
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Commencez par .github/workflows/openapi_check.yaml et comparez son comportement avec l’issue #646 liée de stoplightio/spectral-action. Confirmez comment les annotations sont attachées aux exécutions du workflow, puis vérifiez que les avertissements et les erreurs apparaissent dans la bonne exécution et que les deux fichiers OpenAPI, ou tous les fichiers OpenAPI, sont vérifiés lorsqu’ils sont présents.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
github-actions, yaml
Domaine
api, ci-cd
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.