Project: KICS (Provisioning / Security & Compliance)
File: bccfa089-89e4-47e0-a0e5-185fe6902220.md

title: Response Object With Incorrect Ref (v2) hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: bccfa089-89e4-47e0-a0e5-185fe6902220 Query name: Response Object With Incorrect Ref (v2) Platform: OpenAPI Severity: <span style="color:#5bc0de">Info</span> Category: Structure and Semantics URL: Response Object reference must always point to '#/responses'<br> ```json title="Positive test num. 1 - json file" hl_lines="14" { "swagger": "2.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "$ref": "#/definitions/User" } }, "parameters": [ { "$ref": "#/parameters/limitParam" } ] } } }, "responses": { "Success": { "description": "An array with users", "schema": { "$ref": "#/definitions/User" } } }, "parameters": { "limitParam": { "name": "limit", "in": "body", "description": "max records to return", "required": true, "schema": { "type": "integer" } } }, "definitions": { "User": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } ``` ```yaml title="Positive test num. 2 - yaml file" hl_lines="12" swagger: '2.0' info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: '200': "$ref": "#/definitions/User" parameters: "$ref": "#/parameters/limitParam" responses: Success: description: An array with users schema: "$ref": "#/definitions/User" parameters: limitParam: name: limit in: body description: max records to return required: true schema: type: integer definitions: User: type: object required: id name properties: id: type: integer format: int64 name: type: string ``` ```json title="Negative test num. 1 - json file" { "swagger": "2.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "$ref": "#/responses/Success" } }, "parameters": [ { "$ref": "#/parameters/limitParam" } ] } } }, "responses": { "Success": { "description": "An array with users", "schema": { "$ref": "#/definitions/User" } } }, "parameters": { "limitParam": { "name": "limit", "in": "body", "description": "max records to return", "required": true, "schema": { "type": "integer" } } }, "definitions": { "User": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } ``` ```yaml title="Negative test num. 2 - yaml file" swagger: '2.0' info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: '200': "$ref": "#/responses/Success" parameters: "$ref": "#/parameters/limitParam" responses: Success: description: An array with users schema: "$ref": "#/definitions/User" parameters: limitParam: name: limit in: body description: max records to return required: true schema: type: integer definitions: User: type: object required: id name properties: id: type: integer format: int64 name: type: string ```