Fix #540 PathItem.from_routes/1 dialyzer warnings

open-api-spex · May 30, 2023 · 055c8e0 · 055c8e0
1 parent a65a7b2
commit 055c8e0
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 7 deletions.
diff --git a/examples/phoenix_app/lib/phoenix_app_web/api_spec.ex b/examples/phoenix_app/lib/phoenix_app_web/api_spec.ex
@@ -1,5 +1,17 @@
 defmodule PhoenixAppWeb.ApiSpec do
-  alias OpenApiSpex.{Components, Info, OpenApi, OAuthFlow, OAuthFlows, Paths, SecurityScheme}
+  alias OpenApiSpex.{
+    Components,
+    Info,
+    OpenApi,
+    OAuthFlow,
+    OAuthFlows,
+    Paths,
+    SecurityScheme,
+    Schema,
+    MediaType,
+    Response
+  }
+
   @behaviour OpenApi
 
   @impl OpenApi

diff --git a/examples/phoenix_app/lib/phoenix_app_web/controllers/user_controller.ex b/examples/phoenix_app/lib/phoenix_app_web/controllers/user_controller.ex
@@ -22,8 +22,8 @@ defmodule PhoenixAppWeb.UserController do
     summary: "List users",
     description: "List all users",
     responses: [
-      ok: {"User List Response", "application/json", Schemas.UsersResponse}
-      unprocessable_entity: %Reference{"$ref": "#/components/responses/unprocessable_entity"},
+      ok: {"User List Response", "application/json", Schemas.UsersResponse},
+      unprocessable_entity: %Reference{"$ref": "#/components/responses/unprocessable_entity"}
     ]
 
   def index(conn, _params) do

diff --git a/examples/phoenix_app/lib/phoenix_app_web/controllers/user_controller_with_struct_specs.ex b/examples/phoenix_app/lib/phoenix_app_web/controllers/user_controller_with_struct_specs.ex
@@ -35,8 +35,8 @@ defmodule PhoenixAppWeb.UserControllerWithStructSpecs do
       description: "List all useres",
       operationId: "UserController.index",
       responses: %{
-        200 => response("User List Response", "application/json", Schemas.UsersResponse)
-        422 => %Reference{"$ref": "#/components/responses/unprocessable_entity"},
+        200 => response("User List Response", "application/json", Schemas.UsersResponse),
+        422 => %Reference{"$ref": "#/components/responses/unprocessable_entity"}
       }
     }
   end

diff --git a/lib/open_api_spex/path_item.ex b/lib/open_api_spex/path_item.ex
@@ -52,8 +52,8 @@ defmodule OpenApiSpex.PathItem do
   Eg from the generated `__routes__` function in a Phoenix.Router module.
   """
   @type route ::
-          %{path: String.t(), verb: atom, plug: atom, opts: any}
-          | %{path: String.t(), verb: atom, plug: atom, plug_opts: any}
+          %{optional(:path) => String.t(), verb: atom, plug: atom, opts: any}
+          | %{optional(:path) => String.t(), verb: atom, plug: atom, plug_opts: any}
 
   @doc """
   Builds a PathItem struct from a list of routes that share a path.