bundesAPI / bundesAPI/api-doc-template

OpenAPI Check Workflow (Annotations) not working correctly

Open
#6 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
6
Forks
4
PR merge metrics
No merged PRs in 30d

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.

Contributor guide

No contributing guide indexed for this repository

Research direction

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.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, yaml
Domain
api, ci-cd
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.