ci: Add validation for api docs #4481
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Solves #3433
Description
Now validate.yml workflow will also check whether the api docs are up to date with the descriptors in
registry/api/v2/descriptors.go
. If yes, then the job passes with no failure, If no, then the job fails will the appropriate error message.Note: It looks like the
docs/content/spec/api.md
is being updated manually so there is some difference between the api markdown and the template file. I have updated the template to match the api markdown in most cases but there a few cases where it just cannot be updated:The differences that have been addressed:
"errors:"
->"errors":