Conversation
Generate spec.json from spec.yml with Redocly, and add a workflow that lints the spec and fails if spec.json is out of date.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Adds a JSON version of the spec alongside
spec.yml, plus a CI check that keeps the two in sync.Changes
spec.json, generated fromspec.ymlwith@redocly/cli bundle..github/workflows/spec.yml, which on every PR and push totrunk:spec.ymlspec.jsonand fails if it differs from the committed fileredocly.yaml, extending the recommended ruleset but disabling rules that don't fit the Akismet API:security-defined: the API key is a form/query parameter, not an OpenAPI security schemeoperation-4xx-response: Akismet returns200with plain-text bodies (e.g.invalid) rather than 4xxinfo-licenseRedocly is pinned to
2.55.0so local and CI output match.Testing
npx @redocly/cli@2.55.0 lint spec.ymlpasses.npx @redocly/cli@2.55.0 bundle spec.yml -o spec.jsonproduces no diff.Notes
Whichever of this and #5 merges second will need
spec.jsonregenerated, since #5 changesspec.yml.