Project: KICS (Provisioning / Security & Compliance)
File: 4cac7ace-b0fb-477d-830d-65395d9109d9.md

title: Schema Object Incorrect Ref (v3) hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: 4cac7ace-b0fb-477d-830d-65395d9109d9 Query name: Schema Object Incorrect Ref (v3) Platform: OpenAPI Severity: <span style="color:#5bc0de">Info</span> Category: Structure and Semantics URL: Schema Object reference must always point to '#/components/schemas'<br> ```json title="Positive test num. 1 - json file" hl_lines="76" { "openapi": "3.0.0", "info": { "title": "Simple API Overview", "version": "1.0.0", "contact": { "name": "contact", "url": "https://www.google.com/", "email": "user@gmail.c" } }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response", "content": { "application/json": { "examples": { "foo": { "value": { "versions": [ { "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "id": "v2.0", "links": [ { "href": "http://127.0.0.1:8774/v2/", "rel": "self" } ] } ] } } } } } } } } } }, "components": { "schemas": { "GeneralError": { "type": "object", "discriminator": { "propertyName": "petType" }, "properties": { "code": { "type": "string", "format": "int32" }, "message": { "type": "string" } }, "required": [ "petType" ] } }, "requestBodies": { "NewItem": { "description": "A JSON object containing item data", "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemads/GeneralError" }, "examples": { "tshirt": { "$ref": "#/components/examples/tshirt" } } } } } } } } ``` ```json title="Positive test num. 2 - json file" hl_lines="16" { "openapi": "3.0.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemads/GeneralError" }, "examples": { "foo": { "value": { "versions": [ { "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "id": "v2.0", "links": [ { "href": "http://127.0.0.1:8774/v2/", "rel": "self" } ] } ] } } } } } } }, "operationId": "listVersionsv2", "summary": "List API versions" } } }, "components": { "schemas": { "GeneralError": { "discriminator": { "propertyName": "petType" }, "properties": { "code": { "type": "string", "format": "int32" }, "message": { "type": "string" } }, "required": [ "petType" ], "type": "object" } } } } ``` ```yaml title="Positive test num. 3 - yaml file" hl_lines="46" openapi: 3.0.0 info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response content: application/json: examples: foo: value: versions: status: CURRENT updated: "2011-01-21T11:33:21Z" id: v2.0 links: href: http://127.0.0.1:8774/v2/ rel: self components: schemas: GeneralError: type: object discriminator: propertyName: petType properties: code: type: string format: int32 message: type: string required: petType requestBodies: NewItem: description: A JSON object containing item data required: true content: multipart/form-data: schema: $ref: "#/components/schemads/GeneralError" examples: tshirt: $ref: "#/components/examples/tshirt" ``` <details><summary>Positive test num. 4 - yaml file</summary> ```yaml hl_lines="16" openapi: 3.0.0 info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response content: application/json: schema: $ref: "#/components/schemads/GeneralError" examples: foo: value: versions: status: CURRENT updated: "2011-01-21T11:33:21Z" id:

links: href: http://127.0.0.1:8774/v2/ rel: self components: schemas: GeneralError: type: object discriminator: propertyName: petType properties: code: type: string format: int32 message: type: string required: petType ``` </details> ```json title="Negative test num. 1 - json file" { "openapi": "3.0.0", "info": { "title": "Simple API Overview", "version": "1.0.0", "contact": { "name": "contact", "url": "https://www.google.com/", "email": "user@gmail.c" } }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response", "content": { "application/json": { "examples": { "foo": { "value": { "versions": [ { "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "id": "v2.0", "links": [ { "href": "http://127.0.0.1:8774/v2/", "rel": "self" } ] } ] } } } } } } } } } }, "components": { "schemas": { "GeneralError": { "type": "object", "discriminator": { "propertyName": "petType" }, "properties": { "code": { "type": "string", "format": "int32" }, "message": { "type": "string" } }, "required": [ "petType" ] } }, "requestBodies": { "NewItem": { "description": "A JSON object containing item data", "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/GeneralError" }, "examples": { "tshirt": { "$ref": "#/components/examples/tshirt" } } } } } } } } ``` ```json title="Negative test num. 2 - json file" { "openapi": "3.0.0", "info": { "title": "Simple API Overview", "version": "1.0.0", "contact": { "name": "contact", "url": "https://www.google.com/", "email": "user@gmail.c" } }, "paths": { "/": { "get": { "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralError" }, "examples": { "foo": { "value": { "versions": [ { "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "id": "v2.0", "links": [ { "href": "http://127.0.0.1:8774/v2/", "rel": "self" } ] } ] } } } } } } }, "operationId": "listVersionsv2", "summary": "List API versions" } } }, "components": { "schemas": { "GeneralError": { "discriminator": { "propertyName": "petType" }, "properties": { "code": { "type": "string", "format": "int32" }, "message": { "type": "string" } }, "required": [ "petType" ], "type": "object" } } } } ``` ```yaml title="Negative test num. 3 - yaml file" openapi: 3.0.0 info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response content: application/json: examples: foo: value: versions: status: CURRENT updated: "2011-01-21T11:33:21Z" id: v2.0 links: href: http://127.0.0.1:8774/v2/ rel: self components: schemas: GeneralError: type: object discriminator: propertyName: petType properties: code: type: string format: int32 message: type: string required: petType requestBodies: NewItem: description: A JSON object containing item data required: true content: multipart/form-data: schema: $ref: "#/components/schemas/GeneralError" examples: tshirt: $ref: "#/components/examples/tshirt" ``` <details><summary>Negative test num. 4 - yaml file</summary> ```yaml openapi: 3.0.0 info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response content: application/json: schema: $ref: "#/components/schemas/GeneralError" examples: foo: value: versions: status: CURRENT updated: "2011-01-21T11:33:21Z" id: v2.0 links: href: http://127.0.0.1:8774/v2/ rel: self components: schemas: GeneralError: type: object discriminator: propertyName: petType properties: code: type: string format: int32 message: type: string required: petType ``` </details>