Exclude empty paths from spec

open-api-spex · Dec 12, 2023 · 4b01a1b · 4b01a1b
1 parent 531607c
commit 4b01a1b
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/lib/open_api_spex/path_item.ex b/lib/open_api_spex/path_item.ex
@@ -69,6 +69,10 @@ defmodule OpenApiSpex.PathItem do
     |> from_valid_routes()
   end
 
+  def empty?(%__MODULE__{} = path_item) do
+    path_item == %__MODULE__{}
+  end
+
   @spec from_valid_routes([route]) :: nil | t
   defp from_valid_routes([]), do: nil
 

diff --git a/lib/open_api_spex/paths.ex b/lib/open_api_spex/paths.ex
@@ -39,6 +39,7 @@ defmodule OpenApiSpex.Paths do
       |> Enum.group_by(fn route -> route.path end)
       |> Enum.map(fn {k, v} -> {open_api_path(k), PathItem.from_routes(v)} end)
       |> Enum.filter(fn {_k, v} -> !is_nil(v) end)
+      |> Enum.reject(fn {_k, v} -> PathItem.empty?(v) end)
       |> Map.new()
 
     paths

diff --git a/test/paths_test.exs b/test/paths_test.exs
@@ -12,6 +12,8 @@ defmodule OpenApiSpex.PathsTest do
                "/api/pets/{id}" => pets_path_item
              } = paths
 
+      refute Map.has_key?(paths, "/api/noapi")
+
       assert pets_path_item.patch.operationId == "OpenApiSpexTest.PetController.update"
       assert pets_path_item.put.operationId == "OpenApiSpexTest.PetController.update (2)"
     end