Skip to content

Erlang server – minor fix to return type and generated doc #20197

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
wing328 merged 3 commits into from
Nov 27, 2024
Merged

Erlang server – minor fix to return type and generated doc #20197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0e6d101
erlang-server: add jesse to app.up release
NelsonVides Nov 16, 2024
ce7b585
erlang-server: remove dialyzer errors that might not be related to th…
NelsonVides Nov 16, 2024
65803a1
erlang-server: minor fixes to return types and generated docs
NelsonVides Nov 27, 2024
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 modules/openapi-generator/src/main/resources/erlang-server/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ prepare_validator(SchemaVer) ->
prepare_validator(get_openapi_path(), SchemaVer).

-doc """
Loads the JSON schema and the desired validation draft into a `t:jesse_state:state()`.
Loads the JSON schema and the desired validation draft into a `t:jesse_state:state/0`.
""".
-spec prepare_validator(file:name_all(), binary()) -> jesse_state:state().
prepare_validator(OpenApiPath, SchemaVer) ->
Expand Down
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/erlang-server/app.src.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{{#appDescription}}"{{.}}"{{/appDescription}}{{^appDescription}}"OpenAPI rest server library"{{/appDescription}}},
{vsn, "{{apiVersion}}"},
{registered, []},
{applications, [kernel, stdlib, public_key, ssl, inets, ranch, cowboy]},
{applications, [kernel, stdlib, public_key, ssl, inets, ranch, cowboy, jesse]},
{env, []},
{modules, []},
{licenses, [{{#licenseInfo}}"{{.}}"{{/licenseInfo}}]},
Expand Down
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/erlang-server/logic_handler.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
{accept_callback_return(), cowboy_req:req(), context()}.

-callback provide_callback({{packageName}}_api:class(), {{packageName}}_api:operation_id(), cowboy_req:req(), context()) ->
{cowboy_req:resp_body(), cowboy_req:req(), context()}.
{provide_callback_return(), cowboy_req:req(), context()}.

-export([api_key_callback/2, accept_callback/4, provide_callback/4]).
-ignore_xref([api_key_callback/2, accept_callback/4, provide_callback/4]).
Expand Down
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/erlang-server/rebar.config.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

{dialyzer,
[{plt_extra_apps, [cowboy, cowlib, ranch, jesse]},
{warnings, [missing_return, unknown]}
{warnings, [no_match, no_unused, missing_return, unknown]}
]}.

{xref_checks,
Expand Down
2 changes: 1 addition & 1 deletion samples/server/echo_api/erlang-server/rebar.config
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

{dialyzer,
[{plt_extra_apps, [cowboy, cowlib, ranch, jesse]},
{warnings, [missing_return, unknown]}
{warnings, [no_match, no_unused, missing_return, unknown]}
]}.

{xref_checks,
Expand Down
2 changes: 1 addition & 1 deletion samples/server/echo_api/erlang-server/src/openapi.app.src
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"Echo Server API"},
{vsn, "1.0.0"},
{registered, []},
{applications, [kernel, stdlib, public_key, ssl, inets, ranch, cowboy]},
{applications, [kernel, stdlib, public_key, ssl, inets, ranch, cowboy, jesse]},
{env, []},
{modules, []},
{licenses, ["Apache 2.0"]},
Expand Down
2 changes: 1 addition & 1 deletion samples/server/echo_api/erlang-server/src/openapi_api.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ prepare_validator(SchemaVer) ->
prepare_validator(get_openapi_path(), SchemaVer).

-doc """
Loads the JSON schema and the desired validation draft into a `t:jesse_state:state()`.
Loads the JSON schema and the desired validation draft into a `t:jesse_state:state/0`.
""".
-spec prepare_validator(file:name_all(), binary()) -> jesse_state:state().
prepare_validator(OpenApiPath, SchemaVer) ->
Expand Down
2 changes: 1 addition & 1 deletion samples/server/echo_api/erlang-server/src/openapi_logic_handler.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
{accept_callback_return(), cowboy_req:req(), context()}.

-callback provide_callback(openapi_api:class(), openapi_api:operation_id(), cowboy_req:req(), context()) ->
{cowboy_req:resp_body(), cowboy_req:req(), context()}.
{provide_callback_return(), cowboy_req:req(), context()}.

-export([api_key_callback/2, accept_callback/4, provide_callback/4]).
-ignore_xref([api_key_callback/2, accept_callback/4, provide_callback/4]).
Expand Down
2 changes: 1 addition & 1 deletion samples/server/petstore/erlang-server/rebar.config
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

{dialyzer,
[{plt_extra_apps, [cowboy, cowlib, ranch, jesse]},
{warnings, [missing_return, unknown]}
{warnings, [no_match, no_unused, missing_return, unknown]}
]}.

{xref_checks,
Expand Down
2 changes: 1 addition & 1 deletion samples/server/petstore/erlang-server/src/openapi.app.src
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters."},
{vsn, "1.0.0"},
{registered, []},
{applications, [kernel, stdlib, public_key, ssl, inets, ranch, cowboy]},
{applications, [kernel, stdlib, public_key, ssl, inets, ranch, cowboy, jesse]},
{env, []},
{modules, []},
{licenses, ["Apache-2.0"]},
Expand Down
2 changes: 1 addition & 1 deletion samples/server/petstore/erlang-server/src/openapi_api.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ prepare_validator(SchemaVer) ->
prepare_validator(get_openapi_path(), SchemaVer).

-doc """
Loads the JSON schema and the desired validation draft into a `t:jesse_state:state()`.
Loads the JSON schema and the desired validation draft into a `t:jesse_state:state/0`.
""".
-spec prepare_validator(file:name_all(), binary()) -> jesse_state:state().
prepare_validator(OpenApiPath, SchemaVer) ->
Expand Down
2 changes: 1 addition & 1 deletion samples/server/petstore/erlang-server/src/openapi_logic_handler.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
{accept_callback_return(), cowboy_req:req(), context()}.

-callback provide_callback(openapi_api:class(), openapi_api:operation_id(), cowboy_req:req(), context()) ->
{cowboy_req:resp_body(), cowboy_req:req(), context()}.
{provide_callback_return(), cowboy_req:req(), context()}.

-export([api_key_callback/2, accept_callback/4, provide_callback/4]).
-ignore_xref([api_key_callback/2, accept_callback/4, provide_callback/4]).
Expand Down
Loading