Added missing bad request case doc

trento-project · May 17, 2022 · 9bc53ba · 9bc53ba
1 parent 99466dd
commit 9bc53ba
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/lib/trento_web/controllers/catalog_controller.ex b/lib/trento_web/controllers/catalog_controller.ex
@@ -28,7 +28,8 @@ defmodule TrentoWeb.CatalogController do
     ],
     responses: [
       ok: {"A Collection of the available Checks", "application/json", ChecksCatalog.Catalog},
-      not_found: {"Not found", "application/json", ChecksCatalog.CatalogNotfound}
+      not_found: {"Not found", "application/json", ChecksCatalog.CatalogNotfound},
+      bad_request: {"Bad Request", "application/json", ChecksCatalog.UnableToLoadCatalog}
     ]
   )
 

diff --git a/lib/trento_web/openapi/schema/checks_catalog.ex b/lib/trento_web/openapi/schema/checks_catalog.ex
@@ -175,4 +175,18 @@ defmodule TrentoWeb.OpenApi.Schema.ChecksCatalog do
       example: %{error: "not_found"}
     })
   end
+
+  defmodule UnableToLoadCatalog do
+    @moduledoc false
+
+    OpenApiSpex.schema(%{
+      title: "UnableToLoadCatalog",
+      description: "Something wrong happened while loading the catalog. ie: it is not ready yet",
+      type: :object,
+      properties: %{
+        error: %Schema{type: :string, description: "The error message"}
+      },
+      example: %{error: "(not_ready|some other error message)"}
+    })
+  end
 end