Skip to content

Fix the Falcon integration to properly handle URLs with query strings. #233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 10, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -260,9 +260,9 @@ For Falcon you can use FalconOpenAPIRequest a Falcon request factory:
.. code-block:: python

from openapi_core.validation.request.validators import RequestValidator
from openapi_core.contrib.falcon import FalconOpenAPIRequest
from openapi_core.contrib.falcon import FalconOpenAPIRequestFactory

openapi_request = FalconOpenAPIRequest(falcon_request)
openapi_request = FalconOpenAPIRequestFactory.create(falcon_request)
validator = RequestValidator(spec)
result = validator.validate(openapi_request)

Expand All @@ -271,9 +271,9 @@ You can use FalconOpenAPIResponse as a Falcon response factory:
.. code-block:: python

from openapi_core.validation.response.validators import ResponseValidator
from openapi_core.contrib.falcon import FalconOpenAPIResponse
from openapi_core.contrib.falcon import FalconOpenAPIResponseFactory

openapi_response = FalconOpenAPIResponse(falcon_response)
openapi_response = FalconOpenAPIResponseFactory.create(falcon_response)
validator = ResponseValidator(spec)
result = validator.validate(openapi_request, openapi_response)

Expand Down
5 changes: 3 additions & 2 deletions openapi_core/contrib/falcon/requests.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ def create(cls, request):
# Support falcon-jsonify.
body = (
dumps(request.json) if getattr(request, "json", None)
else request.bounded_stream.read()
else dumps(request.media)
)
mimetype = request.options.default_media_type
if request.content_type:
Expand All @@ -36,8 +36,9 @@ def create(cls, request):
cookie=request.cookies,
path=path,
)
url_pattern = request.prefix + request.path
return OpenAPIRequest(
full_url_pattern=request.url,
full_url_pattern=url_pattern,
method=method,
parameters=parameters,
body=body,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,18 @@ paths:
description: the ID of the resource to retrieve
schema:
type: integer
- name: detail_level
in: query
required: false
description: optional level of detail to provide
schema:
type: integer
get:
responses:
200:
description: Return the resource.
content:
application/json:
application/json:
schema:
type: object
required:
Expand Down
9 changes: 9 additions & 0 deletions tests/integration/contrib/falcon/test_falcon_validation.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,12 @@ def test_request_validator_path_pattern(self, spec, request_factory):
openapi_request = FalconOpenAPIRequestFactory.create(request)
result = validator.validate(openapi_request)
assert not result.errors

def test_request_validator_with_query(self, spec, request_factory):
validator = RequestValidator(spec)
request = request_factory('GET', '/browse/12',
query_string='detail_level=2',
subdomain='kb')
openapi_request = FalconOpenAPIRequestFactory.create(request)
result = validator.validate(openapi_request)
assert not result.errors