From 0e6d101d80930173b34d4e2a38b2aa6dffa357a9 Mon Sep 17 00:00:00 2001 From: Nelson Vides Date: Sat, 16 Nov 2024 16:48:17 +0100 Subject: [PATCH 1/3] erlang-server: add jesse to app.up release --- .../src/main/resources/erlang-server/app.src.mustache | 2 +- samples/server/echo_api/erlang-server/src/openapi.app.src | 2 +- samples/server/petstore/erlang-server/src/openapi.app.src | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/openapi-generator/src/main/resources/erlang-server/app.src.mustache b/modules/openapi-generator/src/main/resources/erlang-server/app.src.mustache index a7ab1dbc1492..e9a643f05527 100644 --- a/modules/openapi-generator/src/main/resources/erlang-server/app.src.mustache +++ b/modules/openapi-generator/src/main/resources/erlang-server/app.src.mustache @@ -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}}]}, diff --git a/samples/server/echo_api/erlang-server/src/openapi.app.src b/samples/server/echo_api/erlang-server/src/openapi.app.src index 95507ce40e9c..7ceeda9702f0 100644 --- a/samples/server/echo_api/erlang-server/src/openapi.app.src +++ b/samples/server/echo_api/erlang-server/src/openapi.app.src @@ -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"]}, diff --git a/samples/server/petstore/erlang-server/src/openapi.app.src b/samples/server/petstore/erlang-server/src/openapi.app.src index 0172627719b7..401895674221 100644 --- a/samples/server/petstore/erlang-server/src/openapi.app.src +++ b/samples/server/petstore/erlang-server/src/openapi.app.src @@ -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"]}, From ce7b585a7c87a85afc1943520892dc83e58193cd Mon Sep 17 00:00:00 2001 From: Nelson Vides Date: Sat, 16 Nov 2024 17:12:48 +0100 Subject: [PATCH 2/3] erlang-server: remove dialyzer errors that might not be related to the program --- .../src/main/resources/erlang-server/rebar.config.mustache | 2 +- samples/server/echo_api/erlang-server/rebar.config | 2 +- samples/server/petstore/erlang-server/rebar.config | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/openapi-generator/src/main/resources/erlang-server/rebar.config.mustache b/modules/openapi-generator/src/main/resources/erlang-server/rebar.config.mustache index 50cd482ca39b..3e8842e80b4a 100644 --- a/modules/openapi-generator/src/main/resources/erlang-server/rebar.config.mustache +++ b/modules/openapi-generator/src/main/resources/erlang-server/rebar.config.mustache @@ -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, diff --git a/samples/server/echo_api/erlang-server/rebar.config b/samples/server/echo_api/erlang-server/rebar.config index 50cd482ca39b..3e8842e80b4a 100644 --- a/samples/server/echo_api/erlang-server/rebar.config +++ b/samples/server/echo_api/erlang-server/rebar.config @@ -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, diff --git a/samples/server/petstore/erlang-server/rebar.config b/samples/server/petstore/erlang-server/rebar.config index 50cd482ca39b..3e8842e80b4a 100644 --- a/samples/server/petstore/erlang-server/rebar.config +++ b/samples/server/petstore/erlang-server/rebar.config @@ -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, From 65803a1a50ddd24872ee1463f72a8029cd202791 Mon Sep 17 00:00:00 2001 From: Nelson Vides Date: Wed, 27 Nov 2024 10:35:18 +0100 Subject: [PATCH 3/3] erlang-server: minor fixes to return types and generated docs --- .../src/main/resources/erlang-server/api.mustache | 2 +- .../src/main/resources/erlang-server/logic_handler.mustache | 2 +- samples/server/echo_api/erlang-server/src/openapi_api.erl | 2 +- .../server/echo_api/erlang-server/src/openapi_logic_handler.erl | 2 +- samples/server/petstore/erlang-server/src/openapi_api.erl | 2 +- .../server/petstore/erlang-server/src/openapi_logic_handler.erl | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/modules/openapi-generator/src/main/resources/erlang-server/api.mustache b/modules/openapi-generator/src/main/resources/erlang-server/api.mustache index 1f0a90e2cd96..157e2b7a39ef 100644 --- a/modules/openapi-generator/src/main/resources/erlang-server/api.mustache +++ b/modules/openapi-generator/src/main/resources/erlang-server/api.mustache @@ -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) -> diff --git a/modules/openapi-generator/src/main/resources/erlang-server/logic_handler.mustache b/modules/openapi-generator/src/main/resources/erlang-server/logic_handler.mustache index e69edcc81414..3dcaea8c91b2 100644 --- a/modules/openapi-generator/src/main/resources/erlang-server/logic_handler.mustache +++ b/modules/openapi-generator/src/main/resources/erlang-server/logic_handler.mustache @@ -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]). diff --git a/samples/server/echo_api/erlang-server/src/openapi_api.erl b/samples/server/echo_api/erlang-server/src/openapi_api.erl index 30e7447bcfbd..f528518af8c5 100644 --- a/samples/server/echo_api/erlang-server/src/openapi_api.erl +++ b/samples/server/echo_api/erlang-server/src/openapi_api.erl @@ -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) -> diff --git a/samples/server/echo_api/erlang-server/src/openapi_logic_handler.erl b/samples/server/echo_api/erlang-server/src/openapi_logic_handler.erl index d47132f08238..b0daeb1f9f55 100644 --- a/samples/server/echo_api/erlang-server/src/openapi_logic_handler.erl +++ b/samples/server/echo_api/erlang-server/src/openapi_logic_handler.erl @@ -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]). diff --git a/samples/server/petstore/erlang-server/src/openapi_api.erl b/samples/server/petstore/erlang-server/src/openapi_api.erl index 42c168b7a731..f8922a379cf2 100644 --- a/samples/server/petstore/erlang-server/src/openapi_api.erl +++ b/samples/server/petstore/erlang-server/src/openapi_api.erl @@ -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) -> diff --git a/samples/server/petstore/erlang-server/src/openapi_logic_handler.erl b/samples/server/petstore/erlang-server/src/openapi_logic_handler.erl index d47132f08238..b0daeb1f9f55 100644 --- a/samples/server/petstore/erlang-server/src/openapi_logic_handler.erl +++ b/samples/server/petstore/erlang-server/src/openapi_logic_handler.erl @@ -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]).