CLOUDP-260965: Check that the extention x-xgen-hidden has the correct format #119
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
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.
Ticket
CLOUDP-260965
Description
Add spectral rule to check for the correct format of
x-xgen-hidden-envTesting
I tested locally by adding the
x-xgen-hidden-envextension with the wrong format to multiple places (operation, response and response-body)spectral lint ./tools/cli/test/data/openapi-foas-dev.yaml --ruleset=.spectral.yaml --format stylish --display-only-failures /Users/andrea.angiolillo/workspace/openapi/tools/cli/test/data/openapi-foas-dev.yaml 33350:47 error x-xgen-hidden-env-format Ensure x-xgen-hidden-env extension has the correct format. https://go/openapi-hidden-extension paths./api/atlas/v2/groups/{groupId}/clusters.get.responses[200].content.application/vnd.atlas.2025-01-01+json.x-xgen-hidden-env 33514:43 error x-xgen-hidden-env-format Ensure x-xgen-hidden-env extension has the correct format. https://go/openapi-hidden-extension paths./api/atlas/v2/groups/{groupId}/clusters.post.requestBody.content.application/vnd.atlas.2025-01-01+json.x-xgen-hidden-env 33539:47 error x-xgen-hidden-env-format Ensure x-xgen-hidden-env extension has the correct format. https://go/openapi-hidden-extension paths./api/atlas/v2/groups/{groupId}/clusters.post.responses[201].content.application/vnd.atlas.2025-01-01+json.x-xgen-hidden-env 37609:31 error x-xgen-hidden-env-format Ensure x-xgen-hidden-env extension has the correct format. https://go/openapi-hidden-extension paths./api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion.post.x-xgen-hidden-env 37659:31 error x-xgen-hidden-env-format Ensure x-xgen-hidden-env extension has the correct format. https://go/openapi-hidden-extension paths./api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion.post.x-xgen-hidden-env 45864:23 error x-xgen-hidden-env-format Ensure x-xgen-hidden-env extension has the correct format. https://go/openapi-hidden-extension paths./api/atlas/v2/groups/{groupId}/uss/{name}/backup/restoreJobs.post.x-xgen-hidden-env.envs ✖ 6 problems (6 errors, 0 warnings, 0 infos, 0 hints)