Project: KICS (Provisioning / Security & Compliance)
File: 4190dda7-af03-4cf0-a128-70ac1661ca09.md

title: Property 'allowReserved' of Encoding Object Ignored hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: 4190dda7-af03-4cf0-a128-70ac1661ca09 Query name: Property 'allowReserved' of Encoding Object Ignored Platform: OpenAPI Severity: <span style="color:#5bc0de">Info</span> Category: Best Practices URL: Property 'allowReserved' of the encoding object should be defined when the media type of the request body is 'application/x-www-form-urlencoded'. If not, it will be ignored.<br> ```json title="Positive test num. 1 - json file" hl_lines="49" { "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": { "multipart/data": { "schema": { "type": "object", "properties": { "code": { "type": "string", "format": "binary" } } }, "examples": { "tshirt": { "$ref": "#/components/examples/tshirt" } }, "encoding": { "code": { "contentType": "image/png, image/jpeg", "allowReserved": true } } } } } } } } ``` ```json title="Positive test num. 2 - 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": { "encoding": { "code": { "contentType": "image/png, image/jpeg" } }, "schema": { "properties": { "code": { "type": "string", "format": "binary" }, "message": { "type": "string" } }, "type": "object", "discriminator": { "propertyName": "petType" } } } } } }, "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "string", "format": "binary", "properties": { "code": { "type": "string", "format": "binary" } } }, "encoding": { "code": { "contentType": "image/png, image/jpeg", "allowReserved": true } } } } } } } } } ``` ```yaml title="Positive test num. 3 - yaml file" hl_lines="31" 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: requestBodies: NewItem: description: A JSON object containing item data required: true content: multipart/form-data: schema: type: object properties: code: type: string format: binary examples: tshirt: $ref: "#/components/examples/tshirt" encoding: code: contentType: image/png, image/jpeg allowReserved: true ``` <details><summary>Positive test num. 4 - yaml file</summary> ```yaml hl_lines="30" openapi: 3.0.0 info: title: Simple API Overview version:

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 requestBody: content: multipart/form-data: schema: type: string format: binary properties: code: type: string format: binary encoding: code: contentType: image/png, image/jpeg allowReserved: true ``` </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": "string", "format": "binary" } } }, "examples": { "tshirt": { "$ref": "#/components/examples/tshirt" } }, "encoding": { "code": { "contentType": "image/png, image/jpeg", "allowReserved": true } } } } } } } } ``` ```json title="Negative test num. 2 - 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": { "encoding": { "code": { "contentType": "image/png, image/jpeg" } }, "schema": { "properties": { "code": { "type": "string", "format": "binary" }, "message": { "type": "string" } }, "type": "object", "discriminator": { "propertyName": "petType" } } } } } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "string", "format": "binary", "properties": { "code": { "type": "string", "format": "binary" } } }, "encoding": { "code": { "contentType": "image/png, image/jpeg", "allowReserved": true } } } } } } } } } ``` ```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: requestBodies: NewItem: description: A JSON object containing item data required: true content: application/x-www-form-urlencoded: schema: type: object properties: code: type: string format: binary examples: tshirt: $ref: "#/components/examples/tshirt" encoding: code: contentType: image/png, image/jpeg allowReserved: true ``` <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: type: object discriminator: propertyName: petType properties: code: type: string format: binary message: type: string encoding: code: contentType: image/png, image/jpeg requestBody: content: application/x-www-form-urlencoded: schema: type: string format: binary properties: code: type: string format: binary encoding: code: contentType: image/png, image/jpeg allowReserved: true ``` </details>