Skip to content
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.

Sign up for GitHub

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

fix: ensure we catch all OpenAPIParser::OpenAPIError classes when coercing path parameters for OpenAPI 3 #228

Merged
merged 2 commits into from
Jul 18, 2019
Merged

fix: ensure we catch all OpenAPIParser::OpenAPIError classes when coercing path parameters for OpenAPI 3 #228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f031bf
add test to check that OpenAPI3 should wrap errors for when path para…
mt-kelvintaywl Jul 18, 2019
3a23387
fix rescue to ensure all OpenAPIParser::OpenAPIError are caught
mt-kelvintaywl Jul 18, 2019
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
2 changes: 1 addition & 1 deletion lib/committee/schema_validator/open_api_3/operation_wrapper.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ def coerce_path_parameter(validator_option)
return {} unless options.coerce_value

request_operation.validate_path_params(options)
rescue OpenAPIParser::NotExistRequiredKey => e
rescue OpenAPIParser::OpenAPIError => e
raise Committee::InvalidRequest.new(e.message)
end

Expand Down
11 changes: 11 additions & 0 deletions test/middleware/request_validation_open_api_3_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,17 @@ def app
assert_match(/required parameters query_string not exist in/i, e.message)
end

it "raises error when required path parameter is invalid" do
@app = new_rack_app(raise: true, schema: open_api_3_schema)

e = assert_raises(Committee::InvalidRequest) do
not_an_integer = 'abc'
get "/coerce_path_params/#{not_an_integer}", nil
end

assert_match(/is String but it's not valid integer in/i, e.message)
end

it "optionally raises an error" do
@app = new_rack_app(raise: true, schema: open_api_3_schema)
header "Content-Type", "application/json"
Expand Down