Packages
oaspec
0.47.0
0.68.0
0.67.0
0.66.0
0.65.0
0.64.0
0.63.0
0.62.0
0.61.0
0.60.0
0.59.0
0.58.1
0.58.0
0.57.0
0.56.0
0.55.0
0.54.0
0.53.0
0.52.0
0.51.0
0.50.0
0.49.0
0.48.0
0.47.0
0.46.0
0.45.0
0.44.0
0.43.0
0.42.0
0.41.0
0.40.0
0.39.0
0.38.0
0.37.0
0.36.0
0.35.0
0.34.0
0.33.0
0.32.0
0.31.0
0.30.0
0.29.0
0.28.0
0.27.0
0.26.0
0.25.0
0.24.0
0.23.0
0.22.0
0.21.0
0.20.0
0.19.0
0.18.0
0.17.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.0
0.7.0
0.6.3
0.6.1
0.6.0
0.5.0
0.4.0
0.3.0
0.1.3
Generate Gleam code from OpenAPI 3.x specifications
Current section
Files
Jump to
Current section
Files
src/oaspec@openapi@diagnostic.erl
-module(oaspec@openapi@diagnostic).
-compile([no_auto_import, nowarn_unused_vars, nowarn_unused_function, nowarn_nomatch, inline]).
-define(FILEPATH, "src/oaspec/openapi/diagnostic.gleam").
-export([file_error/1, yaml_error/2, missing_field/3, invalid_value/3, resolve_error/4, capability/5, validation/5, validation_error_both/3, validation_error_server/3, validation_warning_both/3, errors_only/1, warnings_only/1, filter_by_mode/2, to_string/1, to_short_string/1]).
-export_type([phase/0, severity/0, target/0, source_loc/0, diagnostic/0]).
-if(?OTP_RELEASE >= 27).
-define(MODULEDOC(Str), -moduledoc(Str)).
-define(DOC(Str), -doc(Str)).
-else.
-define(MODULEDOC(Str), -compile([])).
-define(DOC(Str), -compile([])).
-endif.
-type phase() :: phase_parse |
phase_normalize |
phase_resolve |
phase_capability_check |
phase_validate |
phase_codegen.
-type severity() :: severity_error | severity_warning.
-type target() :: target_both | target_client | target_server.
-type source_loc() :: {source_loc, integer(), integer()} | no_source_loc.
-type diagnostic() :: {diagnostic,
binary(),
phase(),
severity(),
target(),
binary(),
source_loc(),
binary(),
gleam@option:option(binary())}.
-file("src/oaspec/openapi/diagnostic.gleam", 55).
-spec file_error(binary()) -> diagnostic().
file_error(Detail) ->
{diagnostic,
<<"file_error"/utf8>>,
phase_parse,
severity_error,
target_both,
<<""/utf8>>,
no_source_loc,
Detail,
none}.
-file("src/oaspec/openapi/diagnostic.gleam", 68).
-spec yaml_error(binary(), source_loc()) -> diagnostic().
yaml_error(Detail, Loc) ->
{diagnostic,
<<"yaml_error"/utf8>>,
phase_parse,
severity_error,
target_both,
<<""/utf8>>,
Loc,
Detail,
none}.
-file("src/oaspec/openapi/diagnostic.gleam", 81).
-spec missing_field(binary(), binary(), source_loc()) -> diagnostic().
missing_field(Path, Field, Loc) ->
{diagnostic,
<<"missing_field"/utf8>>,
phase_parse,
severity_error,
target_both,
Path,
Loc,
<<"Missing required field: "/utf8, Field/binary>>,
{some, <<"Check your OpenAPI spec structure."/utf8>>}}.
-file("src/oaspec/openapi/diagnostic.gleam", 98).
-spec invalid_value(binary(), binary(), source_loc()) -> diagnostic().
invalid_value(Path, Detail, Loc) ->
{diagnostic,
<<"invalid_value"/utf8>>,
phase_parse,
severity_error,
target_both,
Path,
Loc,
Detail,
none}.
-file("src/oaspec/openapi/diagnostic.gleam", 119).
-spec resolve_error(
binary(),
binary(),
gleam@option:option(binary()),
source_loc()
) -> diagnostic().
resolve_error(Path, Detail, Hint, Loc) ->
{diagnostic,
<<"resolve_error"/utf8>>,
phase_resolve,
severity_error,
target_both,
Path,
Loc,
Detail,
Hint}.
-file("src/oaspec/openapi/diagnostic.gleam", 141).
-spec capability(
binary(),
binary(),
severity(),
target(),
gleam@option:option(binary())
) -> diagnostic().
capability(Path, Detail, Severity, Target, Hint) ->
{diagnostic,
<<"capability"/utf8>>,
phase_capability_check,
Severity,
Target,
Path,
no_source_loc,
Detail,
Hint}.
-file("src/oaspec/openapi/diagnostic.gleam", 164).
-spec validation(
binary(),
binary(),
severity(),
target(),
gleam@option:option(binary())
) -> diagnostic().
validation(Path, Detail, Severity, Target, Hint) ->
{diagnostic,
<<"validation"/utf8>>,
phase_validate,
Severity,
Target,
Path,
no_source_loc,
Detail,
Hint}.
-file("src/oaspec/openapi/diagnostic.gleam", 191).
?DOC(
" Issue #416: severity / target shortcut builders for the common\n"
" `validation` shapes used in `internal/codegen/validate`. The\n"
" project review noted that the 5-field validation/5 constructor\n"
" gets called 28+ times with the same severity / target pair on\n"
" almost every site; these helpers collapse the common shape and\n"
" let call sites focus on the variable bits (path / detail / hint).\n"
" SeverityError + TargetBoth — the most common shape across\n"
" validate.gleam.\n"
).
-spec validation_error_both(binary(), binary(), gleam@option:option(binary())) -> diagnostic().
validation_error_both(Path, Detail, Hint) ->
validation(Path, Detail, severity_error, target_both, Hint).
-file("src/oaspec/openapi/diagnostic.gleam", 207).
?DOC(
" SeverityError + TargetServer — the second most common shape\n"
" (server-only feature restrictions).\n"
).
-spec validation_error_server(binary(), binary(), gleam@option:option(binary())) -> diagnostic().
validation_error_server(Path, Detail, Hint) ->
validation(Path, Detail, severity_error, target_server, Hint).
-file("src/oaspec/openapi/diagnostic.gleam", 223).
?DOC(
" SeverityWarning + TargetBoth — used when a spec shape is\n"
" supported but the user should know about it.\n"
).
-spec validation_warning_both(binary(), binary(), gleam@option:option(binary())) -> diagnostic().
validation_warning_both(Path, Detail, Hint) ->
validation(Path, Detail, severity_warning, target_both, Hint).
-file("src/oaspec/openapi/diagnostic.gleam", 242).
?DOC(" Filter to only errors (not warnings).\n").
-spec errors_only(list(diagnostic())) -> list(diagnostic()).
errors_only(Issues) ->
gleam@list:filter(
Issues,
fun(E) -> erlang:element(4, E) =:= severity_error end
).
-file("src/oaspec/openapi/diagnostic.gleam", 247).
?DOC(" Filter to only warnings (not errors).\n").
-spec warnings_only(list(diagnostic())) -> list(diagnostic()).
warnings_only(Issues) ->
gleam@list:filter(
Issues,
fun(E) -> erlang:element(4, E) =:= severity_warning end
).
-file("src/oaspec/openapi/diagnostic.gleam", 252).
?DOC(" Filter diagnostics to those relevant for the selected generation mode.\n").
-spec filter_by_mode(list(diagnostic()), oaspec@config:generate_mode()) -> list(diagnostic()).
filter_by_mode(Issues, Mode) ->
case Mode of
client ->
gleam@list:filter(
Issues,
fun(E) -> erlang:element(5, E) /= target_server end
);
server ->
gleam@list:filter(
Issues,
fun(E@1) -> erlang:element(5, E@1) /= target_client end
);
both ->
Issues
end.
-file("src/oaspec/openapi/diagnostic.gleam", 268).
?DOC(" Convert a diagnostic to a human-readable string.\n").
-spec to_string(diagnostic()) -> binary().
to_string(D) ->
Phase_str = case erlang:element(3, D) of
phase_parse ->
<<"Parse"/utf8>>;
phase_normalize ->
<<"Normalize"/utf8>>;
phase_resolve ->
<<"Resolve"/utf8>>;
phase_capability_check ->
<<"CapabilityCheck"/utf8>>;
phase_validate ->
<<"Validate"/utf8>>;
phase_codegen ->
<<"Codegen"/utf8>>
end,
Severity_str = case erlang:element(4, D) of
severity_error ->
<<"Error"/utf8>>;
severity_warning ->
<<"Warning"/utf8>>
end,
Loc_str = case erlang:element(7, D) of
{source_loc, Line, Column} ->
<<<<<<<<" (line "/utf8, (erlang:integer_to_binary(Line))/binary>>/binary,
", column "/utf8>>/binary,
(erlang:integer_to_binary(Column))/binary>>/binary,
")"/utf8>>;
no_source_loc ->
<<""/utf8>>
end,
Pointer_str = case erlang:element(6, D) of
<<""/utf8>> ->
<<""/utf8>>;
P ->
<<" at "/utf8, P/binary>>
end,
Hint_str = case erlang:element(9, D) of
{some, H} ->
<<" "/utf8, H/binary>>;
none ->
<<""/utf8>>
end,
<<<<<<<<<<<<<<<<"["/utf8, Phase_str/binary>>/binary, "] "/utf8>>/binary,
Severity_str/binary>>/binary,
Pointer_str/binary>>/binary,
": "/utf8>>/binary,
(erlang:element(8, D))/binary>>/binary,
Loc_str/binary>>/binary,
Hint_str/binary>>.
-file("src/oaspec/openapi/diagnostic.gleam", 310).
?DOC(" Convert a diagnostic to a short string (for backward-compatible display).\n").
-spec to_short_string(diagnostic()) -> binary().
to_short_string(D) ->
Prefix = case erlang:element(4, D) of
severity_error ->
<<"Error"/utf8>>;
severity_warning ->
<<"Warning"/utf8>>
end,
Loc_str = case erlang:element(7, D) of
{source_loc, Line, Column} ->
<<<<<<<<" (line "/utf8, (erlang:integer_to_binary(Line))/binary>>/binary,
", column "/utf8>>/binary,
(erlang:integer_to_binary(Column))/binary>>/binary,
")"/utf8>>;
no_source_loc ->
<<""/utf8>>
end,
case erlang:element(2, D) of
<<"file_error"/utf8>> ->
erlang:element(8, D);
<<"yaml_error"/utf8>> ->
<<(erlang:element(8, D))/binary, Loc_str/binary>>;
<<"missing_field"/utf8>> ->
Location = oaspec@internal@openapi@diagnostic_format:pointer_to_human(
erlang:element(6, D)
),
Field = gleam@string:replace(
erlang:element(8, D),
<<"Missing required field: "/utf8>>,
<<""/utf8>>
),
<<<<<<<<"Missing required field '"/utf8, Field/binary>>/binary,
"' at "/utf8>>/binary,
Location/binary>>/binary,
(case erlang:element(9, D) of
{some, H} ->
<<". "/utf8, H/binary>>;
none ->
<<""/utf8>>
end)/binary>>;
<<"invalid_value"/utf8>> ->
Location@1 = oaspec@internal@openapi@diagnostic_format:pointer_to_human(
erlang:element(6, D)
),
<<<<<<"Invalid value at "/utf8, Location@1/binary>>/binary,
": "/utf8>>/binary,
(erlang:element(8, D))/binary>>;
_ ->
<<<<<<Prefix/binary, (case erlang:element(6, D) of
<<""/utf8>> ->
<<""/utf8>>;
P ->
<<" at "/utf8,
(oaspec@internal@openapi@diagnostic_format:pointer_to_human(
P
))/binary>>
end)/binary>>/binary, ": "/utf8>>/binary, (erlang:element(
8,
D
))/binary>>
end.