From d805a5b3243923282661ad74e3911ca56a4f4111 Mon Sep 17 00:00:00 2001 From: Bianca Lisle Date: Tue, 18 Mar 2025 20:50:42 +0000 Subject: [PATCH] CLOUDP-307054-2: Extend linting to report invalid placement of x-xgen-hidden-env --- tools/spectral/.spectral.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/tools/spectral/.spectral.yaml b/tools/spectral/.spectral.yaml index d680328161..851b2fc6a9 100644 --- a/tools/spectral/.spectral.yaml +++ b/tools/spectral/.spectral.yaml @@ -158,6 +158,28 @@ rules: functionOptions: match: "^(dev|qa|stage|prod)(,(dev|qa|stage|prod))*$" + no-hidden-env-extension-in-invalid-places: + description: "The x-xgen-hidden-env extension should not be placed in invalid locations." + message: "The x-xgen-hidden-env extension is not allowed in this location." + severity: error + given: "$..x-xgen-hidden-env" + then: + field: "$ref" + function: falsy + functionOptions: + paths: + - "$.components.parameters[*].x-xgen-hidden-env" + - "$.components.headers[*].x-xgen-hidden-env" + - "$.components.links[*].x-xgen-hidden-env" + - "$.components.callbacks[*].x-xgen-hidden-env" + - "$.components.examples[*].x-xgen-hidden-env" + - "$.components.securitySchemes[*].x-xgen-hidden-env" + - "$.components.x-xgen-hidden-env" + - "$.paths[*][*].parameters[*].x-xgen-hidden-env" + - "$.paths[*][*].parameters[*].schema.x-xgen-hidden-env" + - "$.paths[*][*].parameters[*].content[*].schema.x-xgen-hidden-env" + + soa-migration-extension: description: "Ensure the x-xgen-soa-migration extension is valid." message: "The x-xgen-soa-migration extension must include 'additionalServices', 'targetService', 'allowDocsDiff', and 'docsSource'."