Skip to content

fix format validation of array items #13

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

Merged
maxlapshin merged 1 commit into from
Sep 1, 2025
Merged

fix format validation of array items #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 0 deletions src/openapi_schema.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ prepare_type(#{oneOf := Types} = Type0) ->
Type0#{oneOf := [prepare_type(T) || T <- Types]};
prepare_type(#{type := <<"object">>, properties := Props} = Type0) ->
Type0#{properties => maps:map(fun(_, T) -> prepare_type(T) end, Props)};
prepare_type(#{type := <<"array">>, items := Items} = Type0) ->
Type0#{items => prepare_type(Items)};
prepare_type(#{} = Type0) ->
% Convert format name to atom. This matches validators syntax
Type1 = case Type0 of
Expand Down
18 changes: 14 additions & 4 deletions test/openapi_schema_SUITE.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ init_per_suite(Config) ->
openapi_handler:load_schema(SchemaPath, test_openapi),
BigOpenapiPath = code:lib_dir(openapi_handler) ++ "/test/redocly-big-openapi.json",
openapi_handler:load_schema(BigOpenapiPath, big_openapi),
ExamplePath = code:lib_dir(openapi_handler) ++ "/test/example-openapi.json",
openapi_handler:load_schema(ExamplePath, example_openapi),
Config.

end_per_suite(Config) ->
Expand Down Expand Up @@ -302,10 +304,18 @@ external_validators(_) ->
{error, Err2} = openapi_schema:process(<<" ab cd">>, #{schema => Schema, validators => Validators}),
#{error := wrong_format, format := no_space, detail := leading_space} = Err2,

% format validators work with loaded schema
% big_openapi.digest is a composition of allOf and object, so it needs schema to be properly prepared
#{password := <<"ab_cd">>} = openapi_schema:process(
#{username => <<"Joe">>, password => <<"ab cd">>}, #{name => big_openapi, type => digest, validators => #{password => fun no_space_validator/1}}),
% format validators work with loaded schema (to ensure openapi_schema:prepare_type works well)
% as simple value
<<"ab_cd">> = openapi_schema:process(<<"ab cd">>, #{name => example_openapi, type => external_validators_simple, validators => Validators}),
{error, _} = openapi_schema:process(<<" cd">>, #{name => example_openapi, type => external_validators_simple, validators => Validators}),
% as array item (nested)
[[<<"ab_cd">>]] = openapi_schema:process([[<<"ab cd">>]], #{name => example_openapi, type => external_validators_array, validators => Validators}),
{error, _} = openapi_schema:process([[<<" cd">>]], #{name => example_openapi, type => external_validators_array, validators => Validators}),
% as object key (nested)
#{in_object := #{prop1 := <<"ab_cd">>}} =
openapi_schema:process(#{in_object => #{prop1 => <<"ab cd">>}}, #{name => example_openapi, type => external_validators_object, validators => Validators}),
{error, _} =
openapi_schema:process(#{in_object => #{prop1 => <<" cd">>}}, #{name => example_openapi, type => external_validators_object, validators => Validators}),

% format validator and pattern work simultaneously
Schema2 = #{type => <<"string">>, format => no_space, pattern => <<"^[a-z]+$">>},
Expand Down