Project: KICS (Provisioning / Security & Compliance)
File: 0de50145-e845-47f4-9a15-23bcf2125710.md

title: Path Parameter Not Required (v3) hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: 0de50145-e845-47f4-9a15-23bcf2125710 Query name: Path Parameter Not Required (v3) Platform: OpenAPI Severity: <span style="color:#5bc0de">Info</span> Category: Structure and Semantics URL: The property 'required' determines whether the parameter is mandatory. If the parameter location is 'path', this property is required and its value must be true.<br> ```json title="Positive test num. 1 - json file" hl_lines="43" { "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": "path", "description": "ID of the API version", "required": false, "schema": { "type": "integer" } } ] } } } ``` ```yaml title="Positive test num. 2 - yaml file" hl_lines="26" 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: path description: ID of the API version required: false schema: type: integer ``` ```json title="Positive test num. 3 - json file" hl_lines="43" { "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": "path", "description": "ID of the API version", "schema": { "type": "integer" } } ] } } } ``` <details><summary>Positive test num. 4 - yaml file</summary> ```yaml hl_lines="26" 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:

rel: self parameters: name: id in: path description: ID of the API version schema: type: integer ``` </details> <details><summary>Positive test num. 5 - json file</summary> ```json hl_lines="10 19" { "openapi": "3.0.0", "info": { "title": "Simple API overview", "version": "1.0.0" }, "components": { "parameters": { "idParam": { "name": "id", "in": "path", "description": "ID of the API the version", "required": false, "schema": { "type": "integer" } }, "nameParam": { "name": "nameAPI", "in": "path", "description": "Name of the API the version", "schema": { "type": "integer" } } } }, "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": [ { "$ref": "#components/parameters/idParam" } ] } } } ``` </details> <details><summary>Positive test num. 6 - yaml file</summary> ```yaml hl_lines="8 15" openapi: 3.0.0 info: title: Simple API overview version: 1.0.0 components: parameters: idParam: name: id in: path description: ID of the API version required: false schema: type: integer nameParam: name: nameAPI in: path description: Name of the API version schema: type: integer 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: $ref: "#components/parameters/idParam" ``` </details> <details><summary>Positive test num. 7 - json file</summary> ```json hl_lines="20" { "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" } } }, "parameters": [ { "name": "id", "in": "path", "description": "ID of the API version", "type": "string" } ] } } } ``` </details> <details><summary>Positive test num. 8 - yaml file</summary> ```yaml 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": description: 200 response parameters: name: id in: path description: ID of the API version type: string ``` </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": [ { "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "id": "v2.0", "links": [ { "href":

"rel": "self" } ] } ] } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "ID of the API the version", "required": true, "schema": { "type": "integer" } } ] } } } ``` ```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: 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: path description: ID of the API version required: true schema: type: integer ``` ```json title="Negative test num. 3 - json file" { "openapi": "3.0.0", "info": { "title": "Simple API overview", "version": "1.0.0" }, "components": { "parameters": { "idParam": { "name": "id", "in": "path", "description": "ID of the API the version", "required": true, "schema": { "type": "integer" } } } }, "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": [ { "$ref": "#components/parameters/idParam" } ] } } } ``` <details><summary>Negative test num. 4 - yaml file</summary> ```yaml openapi: 3.0.0 info: title: Simple API overview version: 1.0.0 components: parameters: idParam: name: id in: path description: ID of the API version required: true schema: type: integer 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: $ref: "#components/parameters/idParam" ``` </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" } } }, "parameters": [ { "name": "id", "in": "path", "description": "ID of the API version", "type": "string", "required": true } ] } } } ``` </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 parameters: name: id in: path description: ID of the API version type: string required: true ``` </details>