Project: KICS (Provisioning / Security & Compliance)
File: 3fb03214-25d4-4bd4-867c-c2d8d708a483.md

title: Properties Missing Required Property (v3) hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: 3fb03214-25d4-4bd4-867c-c2d8d708a483 Query name: Properties Missing Required Property (v3) Platform: OpenAPI Severity: <span style="color:#5bc0de">Info</span> Category: Structure and Semantics URL: Schema Object should have all required properties defined<br> ```json title="Positive test num. 1 - json file" hl_lines="56" { "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": [ { "links": [ { "href": "http://127.0.0.1:8774/v2/", "rel": "self" } ], "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "id": "v2.0" } ] } } } } } } } } } }, "components": { "requestBodies": { "NewItem": { "description": "A JSON object containing item data", "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "object", "required": [ "name" ], "properties": { "age": { "type": "integer" } } } } }, "encoding": { "code": { "contentType": "image/png, image/jpeg", "allowReserved": true } } } } } } } } ``` ```yaml title="Positive test num. 2 - yaml file" hl_lines="38" 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: links: href: http://127.0.0.1:8774/v2/ rel: self status: CURRENT updated: "2011-01-21T11:33:21Z" id: v2.0 components: requestBodies: NewItem: description: A JSON object containing item data required: true content: application/x-www-form-urlencoded: schema: type: object properties: code: type: object required: name properties: age: type: integer encoding: code: contentType: image/png, image/jpeg allowReserved: true ``` ```json title="Positive test num. 3 - json file" hl_lines="54" { "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" } ] } ] } } } } } } } }, "parameters": [ { "name": "id", "in": "query", "description": "ID of the API the version", "required": true, "allowReserved": true, "schema": { "type": "object", "properties": { "code": { "type": "object", "required": [ "name" ], "properties": { "age": { "type": "integer" } } } } } } ] } } } ``` <details><summary>Positive test num. 4 - yaml file</summary> ```yaml hl_lines="37" 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 parameters: name: id in: query description: ID of the API the version required: true allowReserved: true schema: type: object properties: code: type: object required: name properties: age: type: integer ``` </details> <details><summary>Positive test num. 5 - json file</summary> ```json hl_lines="27" { "swagger": "2.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response" } } } } }, "definitions": { "MyObject": { "type": "object", "properties": { "code": { "type": "object", "required": [ "name" ], "properties": { "age": { "type": "integer" } } } } } } } ``` </details> <details><summary>Positive test num. 6 - yaml file</summary> ```yaml hl_lines="20" swagger: "2.0" info: title: Simple API Overview version:

paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response definitions: MyObject: type: object properties: code: type: object required: name properties: age: type: integer ``` </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", "content": { "application/json": { "examples": { "foo": { "value": { "versions": [ { "links": [ { "href": "http://127.0.0.1:8774/v2/", "rel": "self" } ], "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "id": "v2.0" } ] } } } } } } } } } }, "components": { "requestBodies": { "NewItem": { "description": "A JSON object containing item data", "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "age": { "type": "integer" } } } } }, "encoding": { "code": { "contentType": "image/png, image/jpeg", "allowReserved": true } } } } } } } } ``` ```yaml title="Negative test num. 2 - 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: links: href: http://127.0.0.1:8774/v2/ rel: self status: CURRENT updated: "2011-01-21T11:33:21Z" id: v2.0 components: requestBodies: NewItem: description: A JSON object containing item data required: true content: application/x-www-form-urlencoded: schema: type: object properties: code: type: object required: name properties: name: type: string age: type: integer encoding: code: contentType: image/png, image/jpeg allowReserved: true ``` ```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": "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" } ] } ] } } } } } } } }, "parameters": [ { "name": "id", "in": "query", "description": "ID of the API the version", "required": true, "allowReserved": true, "schema": { "type": "object", "properties": { "code": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "age": { "type": "integer" } } } } } } ] } } } ``` <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: 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 parameters: name: id in: query description: ID of the API the version required: true allowReserved: true schema: type: object properties: code: type: object required: name properties: name: type: string age: type: integer ``` </details> <details><summary>Negative test num. 5 - json file</summary> ```json { "swagger": "2.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response" } } } } }, "definitions": { "MyObject": { "type": "object", "properties": { "code": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "age": { "type": "integer" } } } } } } } ``` </details> <details><summary>Negative test num. 6 - yaml file</summary> ```yaml swagger: "2.0" info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response definitions: MyObject: type: object properties: code: type: object required: name properties: name: type: string