Title: [Bug]: encoding not supported for individual requestBody properties · Issue #642 · python-openapi/openapi-core · GitHub
Open Graph Title: [Bug]: encoding not supported for individual requestBody properties · Issue #642 · python-openapi/openapi-core
X Title: [Bug]: encoding not supported for individual requestBody properties · Issue #642 · python-openapi/openapi-core
Description: Actual Behavior OpenAPI allows specifying an application/x-www-form-urlencoded request body that contains individual application/json encoded properties, by using the contentType field of the encoding object. The Swagger specification sh...
Open Graph Description: Actual Behavior OpenAPI allows specifying an application/x-www-form-urlencoded request body that contains individual application/json encoded properties, by using the contentType field of the encod...
X Description: Actual Behavior OpenAPI allows specifying an application/x-www-form-urlencoded request body that contains individual application/json encoded properties, by using the contentType field of the encod...
Opengraph URL: https://github.com/python-openapi/openapi-core/issues/642
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Bug]: encoding not supported for individual requestBody properties","articleBody":"### Actual Behavior\n\nOpenAPI allows specifying an `application/x-www-form-urlencoded` request body that contains individual `application/json` encoded properties, by using the [`contentType` field](https://spec.openapis.org/oas/v3.0.3#encodingContentType) of the [encoding object](https://spec.openapis.org/oas/v3.0.3#mediaTypeEncoding). The Swagger specification shows an [example](https://swagger.io/docs/specification/describing-request-body/) of this (under “Complex Serialization in Form Data”, and reproduced below). However, openapi-core ignores the `contentType` field and fails to validate a valid request against such a spec.\r\n\r\n```pytb\r\nTraceback (most recent call last):\r\n File \"/home/anders/python/openapi-core/openapi_core/validation/decorators.py\", line 31, in wrapper\r\n return f(*args, **kwds)\r\n File \"/home/anders/python/openapi-core/openapi_core/validation/request/validators.py\", line 253, in _get_body\r\n return self._get_content_value(raw_body, mimetype, content)\r\n File \"/home/anders/python/openapi-core/openapi_core/validation/validators.py\", line 126, in _get_content_value\r\n self._validate_schema(schema, casted)\r\n File \"/home/anders/python/openapi-core/openapi_core/validation/validators.py\", line 102, in _validate_schema\r\n validator.validate(value)\r\n File \"/home/anders/python/openapi-core/openapi_core/validation/schemas/validators.py\", line 36, in validate\r\n raise InvalidSchemaValue(value, schema_type, schema_errors=errors)\r\nopenapi_core.validation.schemas.exceptions.InvalidSchemaValue: Value {'payload': '{\"text\":\"Swagger is awesome\"}'} not valid for schema of type object: (\u003cValidationError: '\\'{\"text\":\"Swagger is awesome\"}\\' is not of type \\'object\\''\u003e,)\r\n\r\nThe above exception was the direct cause of the following exception:\r\n\r\nTraceback (most recent call last):\r\n File \"/home/anders/python/openapi-core/post_encoding_test.py\", line 65, in \u003cmodule\u003e\r\n validate_request(request, spec=spec)\r\n File \"/home/anders/python/openapi-core/openapi_core/shortcuts.py\", line 305, in validate_request\r\n validate_apicall_request(\r\n File \"/home/anders/python/openapi-core/openapi_core/shortcuts.py\", line 379, in validate_apicall_request\r\n return v.validate(request)\r\n File \"/home/anders/python/openapi-core/openapi_core/validation/request/validators.py\", line 269, in validate\r\n raise err\r\n File \"/home/anders/python/openapi-core/openapi_core/validation/request/validators.py\", line 110, in _iter_errors\r\n self._get_body(request.body, request.mimetype, operation)\r\n File \"/home/anders/python/openapi-core/openapi_core/validation/decorators.py\", line 33, in wrapper\r\n self._raise_error(exc, self.err_validate_cls, f, *args, **kwds)\r\n File \"/home/anders/python/openapi-core/openapi_core/validation/decorators.py\", line 58, in _raise_error\r\n raise init(**kw) from exc\r\nopenapi_core.validation.request.exceptions.InvalidRequestBody: Request body validation error\r\n```\n\n### Expected Behavior\n\nThis request should successfully validate.\n\n### Steps to Reproduce\n\n```python\r\nimport yaml\r\nfrom urllib.parse import urlencode\r\n\r\nfrom openapi_core import Spec\r\nfrom openapi_core import validate_request\r\nfrom openapi_core.testing import MockRequest\r\n\r\nSPEC = r\"\"\"\r\nopenapi: 3.0.0\r\ninfo:\r\n version: 1.0.0\r\n title: Slack Incoming Webhook\r\nexternalDocs:\r\n url: https://api.slack.com/incoming-webhooks\r\n\r\nservers:\r\n - url: https://hooks.slack.com\r\n\r\npaths:\r\n /services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX:\r\n post:\r\n summary: Post a message to Slack\r\n requestBody:\r\n content:\r\n\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/Message'\r\n\r\n application/x-www-form-urlencoded:\r\n schema:\r\n type: object\r\n properties:\r\n payload: # \u003c--- form field that contains the JSON message\r\n $ref: '#/components/schemas/Message'\r\n encoding:\r\n payload:\r\n contentType: application/json\r\n\r\n responses:\r\n '200':\r\n description: OK\r\n\r\ncomponents:\r\n schemas:\r\n Message:\r\n title: A Slack message\r\n type: object\r\n properties:\r\n text:\r\n type: string\r\n description: Message text\r\n required:\r\n - text\r\n\"\"\"\r\n\r\nspec = Spec.from_dict(yaml.safe_load(SPEC))\r\nrequest = MockRequest(\r\n \"https://hooks.slack.com/\",\r\n \"post\",\r\n \"/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX\",\r\n data=urlencode({\"payload\": '{\"text\":\"Swagger is awesome\"}'}),\r\n mimetype=\"application/x-www-form-urlencoded\",\r\n)\r\nvalidate_request(request, spec=spec)\r\n```\n\n### OpenAPI Core Version\n\n0.18.0\n\n### OpenAPI Core Integration\n\nnone\n\n### Affected Area(s)\n\n_No response_\n\n### References\n\n_No response_\n\n### Anything else we need to know?\n\n_No response_\n\n### Would you like to implement a fix?\n\nNone","author":{"url":"https://github.com/andersk","@type":"Person","name":"andersk"},"datePublished":"2023-08-10T00:38:34.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/642/openapi-core/issues/642"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:3ae84d8e-9a7a-18e0-02aa-0d395f92e42b |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8644:161ED0:1D3E2:285FD:697865FA |
| html-safe-nonce | 9327b4ec2a7461423da57e3dc136c1c03a560981eeb9e380113781ad7639df9c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4NjQ0OjE2MUVEMDoxRDNFMjoyODVGRDo2OTc4NjVGQSIsInZpc2l0b3JfaWQiOiI4OTg3MzE0Mjc5NDg0NTE1ODM0IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 8a2d957aa17523d0b45b46e152e59a14acf96015e2bc6c3550ee2a59fcdf74ba |
| hovercard-subject-tag | issue:1844226095 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python-openapi/openapi-core/642/issue_layout |
| twitter:image | https://opengraph.githubassets.com/c601bdb5772a196477707dea641af4b6c9fc09e50a7c15aa0cff937af6277ba9/python-openapi/openapi-core/issues/642 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/c601bdb5772a196477707dea641af4b6c9fc09e50a7c15aa0cff937af6277ba9/python-openapi/openapi-core/issues/642 |
| og:image:alt | Actual Behavior OpenAPI allows specifying an application/x-www-form-urlencoded request body that contains individual application/json encoded properties, by using the contentType field of the encod... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | andersk |
| hostname | github.com |
| expected-hostname | github.com |
| None | 2981c597c945c1d90ac6fa355ce7929b2f413dfe7872ca5c435ee53a24a1de50 |
| turbo-cache-control | no-preview |
| go-import | github.com/python-openapi/openapi-core git https://github.com/python-openapi/openapi-core.git |
| octolytics-dimension-user_id | 126442889 |
| octolytics-dimension-user_login | python-openapi |
| octolytics-dimension-repository_id | 104200746 |
| octolytics-dimension-repository_nwo | python-openapi/openapi-core |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 104200746 |
| octolytics-dimension-repository_network_root_nwo | python-openapi/openapi-core |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 520b65a872113b919c1bbdb03834a50af15859fd |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width