Project: KICS (Provisioning / Security & Compliance)
File: 7f203940-39c4-4ea7-91ee-7aba16bca9e2.md

title: Property 'allowReserved' Improperly Defined hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: 7f203940-39c4-4ea7-91ee-7aba16bca9e2 Query name: Property 'allowReserved' Improperly Defined Platform: OpenAPI Severity: <span style="color:#5bc0de">Info</span> Category: Structure and Semantics URL: Property 'allowReserved' should be only defined for query parameters<br> ```json title="Positive test num. 1 - json file" hl_lines="43 59" { "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 the version", "required": true, "allowReserved": true, "schema": { "type": "integer" } } ] }, "/users/{id}": { "get": { "parameters": [ { "in": "path", "name": "id", "required": true, "allowReserved": true, "description": "The user ID", "schema": { "type": "integer", "minimum": 1 } } ] } } } } ``` ```yaml title="Positive test num. 2 - yaml file" hl_lines="26 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: path description: ID of the API version required: true allowReserved: true schema: type: integer /users/{id}: get: parameters: in: path name: id required: true allowReserved: true description: The user ID schema: type: integer minimum: 1 ``` ```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 the version", "required": true, "allowReserved": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } } } } ] } } } ``` <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 required: true allowReserved: true content: application/json: schema: type: object required: name properties: name: 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": "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": "integer" } } ] }, "/users/{id}": { "get": { "parameters": [ { "in": "query", "name": "id", "required": true, "allowReserved": true, "description": "The user ID", "schema": { "type": "integer", "minimum": 1 } } ] } } } } ``` ```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: query description: ID of the API version required: true allowReserved: true schema: type: integer /users/{id}: get: parameters: in: query name: id required: true allowReserved: true description: The user ID schema: type: integer minimum: 1 ``` ```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, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } } } } ] } } } ``` <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 version required: true allowReserved: true content: application/json: schema: type: object required: name properties: name: type: string ``` </details>