Project: KICS (Provisioning / Security & Compliance)
File: fb7d81e7-4150-48c4-b914-92fc05da6a2f.md

title: Unknown Property (v3) hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: fb7d81e7-4150-48c4-b914-92fc05da6a2f Query name: Unknown Property (v3) Platform: OpenAPI Severity: <span style="color:#5bc0de">Info</span> Category: Structure and Semantics URL: All properties defined in OpenAPI objects should be known<br> ```json title="Positive test num. 1 - json file" hl_lines="28 14" { "openapi": "3.0.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "descrinnption": "200 response" } } } } }, "security": [ { "exampleSecurity": [] } ], "tags": [ { "name": "pets", "desdddcription": "Everything about your Pets", "externalDocs": { "url": "http://docs.my-api.com/pet-operations.htm" } }, { "name": "store", "description": "Access to Petstore orders", "externalDocs": { "url": "http://docs.my-api.com/store-orders.htm" } } ] } ``` ```json title="Positive test num. 2 - json file" hl_lines="3 20" { "openapi": "3.0.0", "infjnjnjno": { "title": "Simple API Overview", "version": "1.0.0" }, "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "tybhbhbpe:": "object", "discriminator": { "propertyName": "petType" }, "properties": { "code": { "type": "string", "format": "binary" }, "message": { "type": "string" } } }, "encoding": { "code": { "contentType": "image/png, image/jpeg" } } } } } }, "operationId": "listVersionsv2", "summary": "List API versions" } } } } ``` ```json title="Positive test num. 3 - json file" hl_lines="20" { "openapi": "3.0.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "OK" } }, "callbacks": { "inProgress": { "{$request.body#/inProgressUrl}": { "pbhbhbost": { "requestBody": { "$ref": "#/components/requestBodies/callbackMessage1" }, "responses": { "200": { "description": "OK" } } } } } } } } } } ``` <details><summary>Positive test num. 4 - yaml file</summary> ```yaml hl_lines="17 12" openapi: 3.0.0 info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": descrinnption: 200 response security: exampleSecurity: [] tags: name: pets desdddcription: Everything about your Pets externalDocs: url: http://docs.my-api.com/pet-operations.htm name: store description: Access to Petstore orders externalDocs: url: http://docs.my-api.com/store-orders.htm ``` </details> <details><summary>Positive test num. 5 - yaml file</summary> ```yaml hl_lines="2 19" openapi: 3.0.0 infjnjnjno: title: Simple API Overview version: 1.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: tybhbhbpe: object discriminator: propertyName: petType properties: code: type: string format: binary message: type: string encoding: code: contentType: image/png, image/jpeg ``` </details> <details><summary>Positive test

6 - 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: OK callbacks: inProgress: "{$request.body#/inProgressUrl}": pbhbhbost: requestBody: $ref: "#/components/requestBodies/callbackMessage1" responses: "200": description: OK ``` </details> ```json title="Negative test num. 1 - json 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" } } } } }, "security": [ { "exampleSecurity": [] } ], "tags": [ { "name": "pets", "description": "Everything about your Pets", "externalDocs": { "url": "http://docs.my-api.com/pet-operations.htm" } }, { "name": "store", "description": "Access to Petstore orders", "externalDocs": { "url": "http://docs.my-api.com/store-orders.htm" } } ] } ``` ```json title="Negative test num. 2 - json file" { "openapi": "3.0.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "type": "object", "discriminator": { "propertyName": "petType" }, "properties": { "code": { "type": "string", "format": "binary" }, "message": { "type": "string" } } }, "encoding": { "code": { "contentType": "image/png, image/jpeg" } } } } } }, "operationId": "listVersionsv2", "summary": "List API versions" } } } } ``` ```json title="Negative test num. 3 - json 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": "OK" } }, "callbacks": { "inProgress": { "{$request.body#/inProgressUrl}": { "post": { "requestBody": { "$ref": "#/components/requestBodies/callbackMessage1" }, "responses": { "200": { "description": "OK" } } } } } } } } } } ``` <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 security: exampleSecurity: [] tags: name: pets description: Everything about your Pets externalDocs: url: http://docs.my-api.com/pet-operations.htm name: store description: Access to Petstore orders externalDocs: url: http://docs.my-api.com/store-orders.htm ``` </details> <details><summary>Negative test num. 5 - 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: type: object discriminator: propertyName: petType properties: code: type: string format: binary message: type: string encoding: code: contentType: image/png, image/jpeg ``` </details> <details><summary>Negative test num. 6 - 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: OK callbacks: inProgress: "{$request.body#/inProgressUrl}": post: requestBody: $ref: "#/components/requestBodies/callbackMessage1" responses: "200": description: OK ``` </details>