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

* erlang-server: add jesse to app.up release * erlang-server: remove dialyzer errors that might not be related to the program * erlang-server: minor fixes to return types and generated docs
OpenAPITools · Nov 27, 2024 · f8ca36b · f8ca36b
1 parent 47665aa
commit f8ca36b
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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]).