[OpenAPI] Add list of tags in overlay #2905
Merged
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
lcawl
changed the title
shainaraskas
approved these changes
Sep 27, 2024
|
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
|
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
|
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.x 8.x
# Navigate to the new working tree
cd .worktrees/backport-8.x
# Create a new branch
git switch --create backport-2905-to-8.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 4a0eaef2ce8604220d5e089a69a0c2744a00077d
# Push it to GitHub
git push --set-upstream origin backport-2905-to-8.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.xThen, create a pull request where the |
lcawl
added a commit
that referenced
this pull request
Oct 4, 2024
lcawl
added a commit
that referenced
this pull request
Oct 4, 2024
lcawl
added a commit
that referenced
this pull request
Oct 4, 2024
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.
Relates to #2310
As a follow-on to #2961, this PR adds
@doc_tagvalues where we want to override the default tags. There are a few remaining (e.g.health_report,mget,mtermvectors) that we can't override yet because the typescript files for those APIs don't exist yet.This PR also adds the missing document-level list of tags via an overlay. Doing this in an overlay is not perfect since it means that new tags must be manually added. Any endpoints associated with tags that do not appear in this list will not be published on Bump.sh. I've therefore also changed the operation-tag-defined linting rule to an error instead of a warning.
I've also changed the make commands to only lint the OpenAPI documents that have overlays applied, since the others will contain errors that are fixed by the overlays.
NOTE: Even though the list of tags used differs in the two OpenAPI documents (e.g. some endpoints do not exist in the serverless context), it seems okay to use a single tag list since I've tested in Bump.sh and any tags for which there aren't any endpoints are simply omitted.