OpenAPI: Update redocly cli in GH Actions and fix deprecated lint section
#6690
Conversation
This file contains 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
* Disable `security-defined` linter until we document what is public
Redocly previews |
bbrks
commented
Feb 16, 2024
There was a problem hiding this comment.
I plan on adding more to this at another time.
E.g. Describing intention/users of these specs, ref structure, noting x-internal once in place, etc.
| no-ambiguous-paths: off # /{db}/{doc} != /_debug/expvar | ||
| no-identical-paths: off # /{db} != /{targetdb} | ||
| no-path-trailing-slash: off # Some endpoints require a trailing slash | ||
| security-defined: off # TODO: Denote public and authenticated API endpoints with https://redocly.com/docs/cli/rules/security-defined |
There was a problem hiding this comment.
I've filed a ticket for this task (CBG-3789).
I think we should do it (only a few of our endpoints are "public" and require no auth)
bbrks
changed the title
lint sectionlint section
torcolvin
approved these changes
Feb 16, 2024
bbrks
added a commit
that referenced
this pull request
Mar 28, 2024
…ection (#6690) * * Remove deprecated `lint` config. * Disable `security-defined` linter until we document what is public * Add OpenAPI spec readme - will populate with more info another time * Bump action version
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.
Attempt 2 now the GitHub action has been updated to pull the latest version of redocly cli.
Brings GH Action and config up to date with locally run
redoclycommand.Fix deprecated
lintconfig.Fixes:
Disable
security-definedlinterUntil we document what endpoints are public, this avoids the following lint warnings on all endpoints:
Integration Tests