OpenAPI Check Workflow (Annotations) not working correctly
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
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.
Description
The OpenAPI check 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.
- Dominant language
- HTML
- Stars
- 6
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from bundesAPI/api-doc-template
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
All issues in bundesAPI/api-doc-template
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
syfoud/Simulated_Scepter#172 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
crossplane/crossplane#7859 ·
-
bot:ai-assisted component:compact-js status:untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
midnightntwrk/midnight-sdk#403 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
nightscout/nocturne#1379 ·