Title: [Bug]: Raises `DeprecationWarning` for deprecated parameters that were not provided · Issue #931 · python-openapi/openapi-core · GitHub
Open Graph Title: [Bug]: Raises `DeprecationWarning` for deprecated parameters that were not provided · Issue #931 · python-openapi/openapi-core
X Title: [Bug]: Raises `DeprecationWarning` for deprecated parameters that were not provided · Issue #931 · python-openapi/openapi-core
Description: Actual Behavior If I write an OpenAPI document that specifies a parameter foo that’s deprecated: true, and use it to validate a request that does not include that parameter, openapi-core still raises DeprecationWarning: foo parameter is ...
Open Graph Description: Actual Behavior If I write an OpenAPI document that specifies a parameter foo that’s deprecated: true, and use it to validate a request that does not include that parameter, openapi-core still rais...
X Description: Actual Behavior If I write an OpenAPI document that specifies a parameter foo that’s deprecated: true, and use it to validate a request that does not include that parameter, openapi-core still rais...
Opengraph URL: https://github.com/python-openapi/openapi-core/issues/931
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Bug]: Raises `DeprecationWarning` for deprecated parameters that were not provided","articleBody":"### Actual Behavior\r\n\r\nIf I write an OpenAPI document that specifies a parameter `foo` that’s `deprecated: true`, and use it to validate a request that *does not include that parameter*, openapi-core still raises `DeprecationWarning: foo parameter is deprecated` for no reason.\r\n\r\n### Expected Behavior\r\n\r\nNo `DeprecationWarning` should be raised.\r\n\r\nI don’t think `DeprecationWarning` is appropriate at all here, as a `DeprecationWarning` is one that’s “[intended for other Python developers](https://docs.python.org/3/library/exceptions.html#DeprecationWarning)” and not for users of a network API. But at the least, it’s obviously inappropriate when the parameter being warned about was not even provided.\r\n\r\n### Steps to Reproduce\r\n\r\nRun with `python -Werror` (or in another way that enables warnings, such as [development mode](https://docs.python.org/3/library/devmode.html)):\r\n\r\n```python\r\nfrom openapi_core import OpenAPI\r\nfrom openapi_core.testing import MockRequest\r\n\r\nspec = OpenAPI.from_dict(\r\n {\r\n \"openapi\": \"3.1.0\",\r\n \"info\": {\"version\": \"0\", \"title\": \"test\"},\r\n \"paths\": {\r\n \"/test\": {\r\n \"get\": {\r\n \"parameters\": [\r\n {\r\n \"name\": \"foo\",\r\n \"in\": \"query\",\r\n \"schema\": {},\r\n \"deprecated\": True,\r\n },\r\n ],\r\n },\r\n },\r\n },\r\n }\r\n)\r\nspec.validate_request(MockRequest(\"http://localhost\", \"get\", \"/test\"))\r\n```\r\n\r\n```pytb\r\nTraceback (most recent call last):\r\n File \"/home/anders/python/openapi-core/deprecated_test.py\", line 24, in \u003cmodule\u003e\r\n spec.validate_request(MockRequest(\"http://localhost\", \"get\", \"/test\"))\r\n File \"/home/anders/python/openapi-core/openapi_core/app.py\", line 360, in validate_request\r\n self.validate_apicall_request(request)\r\n File \"/home/anders/python/openapi-core/openapi_core/app.py\", line 373, in validate_apicall_request\r\n self.request_validator.validate(request)\r\n File \"/home/anders/python/openapi-core/openapi_core/validation/request/validators.py\", line 286, in validate\r\n for err in self.iter_errors(request):\r\n ^^^^^^^^^^^^^^^^^^^^^^^^^\r\n File \"/home/anders/python/openapi-core/openapi_core/validation/request/validators.py\", line 349, in iter_errors\r\n yield from self._iter_errors(request, operation, path)\r\n File \"/home/anders/python/openapi-core/openapi_core/validation/request/validators.py\", line 115, in _iter_errors\r\n self._get_parameters(request.parameters, operation, path)\r\n File \"/home/anders/python/openapi-core/openapi_core/validation/request/validators.py\", line 172, in _get_parameters\r\n value = self._get_parameter(parameters, param)\r\n ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\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 ^^^^^^^^^^^^^^^^\r\n File \"/home/anders/python/openapi-core/openapi_core/validation/request/validators.py\", line 199, in _get_parameter\r\n warnings.warn(\r\nDeprecationWarning: foo parameter is deprecated\r\n```\r\n\r\n### OpenAPI Core Version\r\n\r\n0.19.4\r\n\r\n### OpenAPI Core Integration\r\n\r\nnone\r\n\r\n### Affected Area(s)\r\n\r\n_No response_\r\n\r\n### References\r\n\r\nvalidation\r\n\r\n### Anything else we need to know?\r\n\r\n_No response_\r\n\r\n### Would you like to implement a fix?\r\n\r\nNone","author":{"url":"https://github.com/andersk","@type":"Person","name":"andersk"},"datePublished":"2024-10-23T03:17:52.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/931/openapi-core/issues/931"}
| 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:a9e78d19-c690-d8eb-81c9-7573aa810b77 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | D7C6:D449A:18B122F:1FFE293:696B2C42 |
| html-safe-nonce | 988391e0d787cff6dab834061d38e893f45a66922e72da685faed63f4aba8188 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEN0M2OkQ0NDlBOjE4QjEyMkY6MUZGRTI5Mzo2OTZCMkM0MiIsInZpc2l0b3JfaWQiOiIxMzY3NDA0MDQyNzY0NjI3MDExIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 3250e6790c1020106e44621794f18e43ba68adb65f620460f2839a6945dd6845 |
| hovercard-subject-tag | issue:2607058361 |
| 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/931/issue_layout |
| twitter:image | https://opengraph.githubassets.com/266fd6b0079dd21ad2b0855676f25fa3d0ada7d3af027d6cb5e90123eb6da7ce/python-openapi/openapi-core/issues/931 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/266fd6b0079dd21ad2b0855676f25fa3d0ada7d3af027d6cb5e90123eb6da7ce/python-openapi/openapi-core/issues/931 |
| og:image:alt | Actual Behavior If I write an OpenAPI document that specifies a parameter foo that’s deprecated: true, and use it to validate a request that does not include that parameter, openapi-core still rais... |
| 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 | 5f99f7c1d70f01da5b93e5ca90303359738944d8ab470e396496262c66e60b8d |
| 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 | 82560a55c6b2054555076f46e683151ee28a19bc |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width