From 3bfbe78661687c6307efa46e2f1c328838a1c6e7 Mon Sep 17 00:00:00 2001 From: EduardoSemanas Date: Tue, 30 Apr 2024 15:14:29 +0100 Subject: [PATCH 1/2] Slight refactor to actually filter the correct/wanted codes --- .../query.rego | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/assets/queries/openAPI/general/response_operations_body_schema_undefined/query.rego b/assets/queries/openAPI/general/response_operations_body_schema_undefined/query.rego index e773ef4c310..5087f9751ae 100644 --- a/assets/queries/openAPI/general/response_operations_body_schema_undefined/query.rego +++ b/assets/queries/openAPI/general/response_operations_body_schema_undefined/query.rego @@ -9,9 +9,9 @@ CxPolicy[result] { version != "undefined" operation := doc.paths[p][op] - acceptable_response(operation, op) - response := operation.responses[code] + acceptable_response(code, op) + key := get_key_by_version(version) not common_lib.valid_key(response, key) @@ -31,9 +31,10 @@ CxPolicy[result] { version == "3.0" operation := doc.paths[path][op] - acceptable_response(operation, op) + response := operation.responses[code] + acceptable_response(code, op) - count(operation.responses[code].content) == 0 + count(response.content) == 0 result := { "documentId": doc.id, @@ -50,9 +51,9 @@ CxPolicy[result] { version == "3.0" operation := doc.paths[path][op] - acceptable_response(operation, op) - response := operation.responses[code] + acceptable_response(code, op) + responses := response.content[content_type] not common_lib.valid_key(responses, "schema") @@ -65,13 +66,12 @@ CxPolicy[result] { } } -acceptable_response(operation, op) { +acceptable_response(code, op) { operation_should_have_content := ["get", "put", "post", "delete", "options", "patch", "trace"] common_lib.equalsOrInArray(operation_should_have_content, lower(op)) response_code_should_not_have_content := ["204", "304"] - response := operation.responses[code] not common_lib.equalsOrInArray(response_code_should_not_have_content, lower(code)) } From 06a6acb69c03a494c8d5de3fcede0e06fd0161c2 Mon Sep 17 00:00:00 2001 From: EduardoSemanas Date: Tue, 30 Apr 2024 15:53:27 +0100 Subject: [PATCH 2/2] Added new Negative UT --- .../test/negative5.json | 115 ++++++++++++++++++ 1 file changed, 115 insertions(+) create mode 100644 assets/queries/openAPI/general/response_operations_body_schema_undefined/test/negative5.json diff --git a/assets/queries/openAPI/general/response_operations_body_schema_undefined/test/negative5.json b/assets/queries/openAPI/general/response_operations_body_schema_undefined/test/negative5.json new file mode 100644 index 00000000000..d1081b2b021 --- /dev/null +++ b/assets/queries/openAPI/general/response_operations_body_schema_undefined/test/negative5.json @@ -0,0 +1,115 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "Test", + "description": "test", + "version": "1.0" + }, + "servers": [ + { + "url": "https://example.com", + "description": "Example" + } + ], + "paths": { + "/Header/{SourceID}": { + "get": { + "summary": "Forecast Header Updates", + "description": "Get Forecast Header channel data from MDM for a given source.", + "operationId": "GetForecastHeader", + "parameters": [], + "responses": { + "200": { + "description": "", + "headers": { + "x-test-forecasts-ack-id": { + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForecastHeaders" + } + }, + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ForecastHeaders" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "There are no more updates available." + } + } + } + }, + "/Detail/{SourceID}": { + "get": { + "summary": "Forecast Detail Updates", + "description": "Get Forecast Header channel data from MDM for a given source.", + "operationId": "GetForecastDetail", + "parameters": [], + "responses": { + "200": { + "description": "", + "headers": { + "x-test-forecastdetails-ack-id": { + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForecastDetails" + } + }, + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ForecastDetails" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "There are no more updates available." + } + } + } + } + }, + "components": { + "schemas": { + }, + "securitySchemes": { + "apiKeyHeader": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + } + }, + "security": [ + { + "apiKeyHeader": [] + }, + { + "apiKeyQuery": [] + } + ] +}