chore: enforce explicit API visibility decisions - #887
Open
Aniruddha-Shriwant wants to merge 2 commits into
Open
chore: enforce explicit API visibility decisions#887Aniruddha-Shriwant wants to merge 2 commits into
Aniruddha-Shriwant wants to merge 2 commits into
Conversation
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.
Description
Adds a Redocly lint rule requiring every added or modified OpenAPI operation to explicitly set
x-internal: trueorx-internal: false.The rule rejects missing markers and non-boolean values. During the migration period, enforcement is scoped to changed OpenAPI source files so existing unclassified operations do not block unrelated work. Once all existing operations are reviewed and backfilled, the same rule can be enabled globally.
When it runs
git config core.hooksPath .githooksmainscripts/lint-visibility.sh --stagedValidation
true,false, missing, invalid type, and changed-file scopingRepository follow-up
After this workflow lands and produces its first status, add the
visibility-lintjob to the required status checks formain. Currently onlysecrets-scanis required by branch protection.Clickup
app.clickup.com