Openapi spex objects refactor (#484)

* OpenApiSpex schemas with struct?: false * OpenApiSpex bumped to 3.19.1 * Controllers refactored to new api schemas
trento-project · Jul 16, 2024 · d9d22d4 · d9d22d4
1 parent 012fd30
commit d9d22d4
Show file tree

Hide file tree

Showing 33 changed files with 917 additions and 826 deletions.
diff --git a/lib/wanda_web/controllers/v1/execution_controller.ex b/lib/wanda_web/controllers/v1/execution_controller.ex
@@ -117,10 +117,9 @@ defmodule WandaWeb.V1.ExecutionController do
       execution_id: execution_id,
       group_id: group_id,
       targets: targets,
-      env: env
-    } = body_params = Map.get(conn, :body_params)
-
-    target_type = Map.get(body_params, :target_type)
+      env: env,
+      target_type: target_type
+    } = OpenApiSpex.body_params(conn)
 
     with :ok <-
            execution_server_impl().start_execution(

diff --git a/lib/wanda_web/controllers/v2/execution_controller.ex b/lib/wanda_web/controllers/v2/execution_controller.ex
@@ -117,10 +117,9 @@ defmodule WandaWeb.V2.ExecutionController do
       execution_id: execution_id,
       group_id: group_id,
       targets: targets,
-      env: env
-    } = body_params = Map.get(conn, :body_params)
-
-    target_type = Map.get(body_params, :target_type)
+      env: env,
+      target_type: target_type
+    } = OpenApiSpex.body_params(conn)
 
     with :ok <-
            execution_server_impl().start_execution(

diff --git a/lib/wanda_web/schemas/accepted_execution_response.ex b/lib/wanda_web/schemas/accepted_execution_response.ex
@@ -10,14 +10,17 @@ defmodule WandaWeb.Schemas.AcceptedExecutionResponse do
 
   require OpenApiSpex
 
-  OpenApiSpex.schema(%{
-    title: "AcceptedExecutionResponse",
-    description: "Identifiers of the recently accepted execution",
-    type: :object,
-    additionalProperties: false,
-    properties: %{
-      execution_id: %Schema{type: :string, format: :uuid},
-      group_id: %Schema{type: :string, format: :uuid}
-    }
-  })
+  OpenApiSpex.schema(
+    %{
+      title: "AcceptedExecutionResponse",
+      description: "Identifiers of the recently accepted execution",
+      type: :object,
+      additionalProperties: false,
+      properties: %{
+        execution_id: %Schema{type: :string, format: :uuid},
+        group_id: %Schema{type: :string, format: :uuid}
+      }
+    },
+    struct?: false
+  )
 end
diff --git a/lib/wanda_web/schemas/bad_request.ex b/lib/wanda_web/schemas/bad_request.ex
@@ -7,27 +7,30 @@ defmodule WandaWeb.Schemas.BadRequest do
 
   require OpenApiSpex
 
-  OpenApiSpex.schema(%{
-    title: "BadRequest",
-    type: :object,
-    additionalProperties: false,
-    properties: %{
-      errors: %Schema{
-        type: :array,
-        items: %Schema{
-          type: :object,
-          additionalProperties: false,
-          properties: %{
-            detail: %Schema{
-              type: :string,
-              example: "Invalid request payload."
-            },
-            title: %Schema{type: :string, example: "Bad Request"}
+  OpenApiSpex.schema(
+    %{
+      title: "BadRequest",
+      type: :object,
+      additionalProperties: false,
+      properties: %{
+        errors: %Schema{
+          type: :array,
+          items: %Schema{
+            type: :object,
+            additionalProperties: false,
+            properties: %{
+              detail: %Schema{
+                type: :string,
+                example: "Invalid request payload."
+              },
+              title: %Schema{type: :string, example: "Bad Request"}
+            }
           }
         }
       }
-    }
-  })
+    },
+    struct?: false
+  )
 
   def response do
     Operation.response(

diff --git a/lib/wanda_web/schemas/health.ex b/lib/wanda_web/schemas/health.ex
@@ -7,21 +7,24 @@ defmodule WandaWeb.Schemas.Health do
 
   require OpenApiSpex
 
-  OpenApiSpex.schema(%Schema{
-    title: "Health",
-    type: :object,
-    additionalProperties: false,
-    example: %{
-      database: "pass"
-    },
-    properties: %{
-      database: %Schema{
-        description: "The status of the database connection",
-        type: :string,
-        enum: ["pass", "fail"]
+  OpenApiSpex.schema(
+    %Schema{
+      title: "Health",
+      type: :object,
+      additionalProperties: false,
+      example: %{
+        database: "pass"
+      },
+      properties: %{
+        database: %Schema{
+          description: "The status of the database connection",
+          type: :string,
+          enum: ["pass", "fail"]
+        }
       }
-    }
-  })
+    },
+    struct?: false
+  )
 
   def response do
     Operation.response(

diff --git a/lib/wanda_web/schemas/not_found.ex b/lib/wanda_web/schemas/not_found.ex
@@ -7,24 +7,27 @@ defmodule WandaWeb.Schemas.NotFound do
 
   require OpenApiSpex
 
-  OpenApiSpex.schema(%{
-    title: "NotFound",
-    type: :object,
-    additionalProperties: false,
-    properties: %{
-      errors: %Schema{
-        type: :array,
-        items: %Schema{
-          type: :object,
-          additionalProperties: false,
-          properties: %{
-            detail: %Schema{type: :string, example: "The requested resource cannot be found."},
-            title: %Schema{type: :string, example: "Not Found"}
+  OpenApiSpex.schema(
+    %{
+      title: "NotFound",
+      type: :object,
+      additionalProperties: false,
+      properties: %{
+        errors: %Schema{
+          type: :array,
+          items: %Schema{
+            type: :object,
+            additionalProperties: false,
+            properties: %{
+              detail: %Schema{type: :string, example: "The requested resource cannot be found."},
+              title: %Schema{type: :string, example: "Not Found"}
+            }
           }
         }
       }
-    }
-  })
+    },
+    struct?: false
+  )
 
   def response do
     Operation.response(

diff --git a/lib/wanda_web/schemas/ready.ex b/lib/wanda_web/schemas/ready.ex
@@ -7,20 +7,23 @@ defmodule WandaWeb.Schemas.Ready do
 
   require OpenApiSpex
 
-  OpenApiSpex.schema(%Schema{
-    title: "Ready",
-    type: :object,
-    additionalProperties: false,
-    example: %{
-      ready: true
-    },
-    properties: %{
-      ready: %Schema{
-        description: "Wanda platform ready",
-        type: :boolean
+  OpenApiSpex.schema(
+    %Schema{
+      title: "Ready",
+      type: :object,
+      additionalProperties: false,
+      example: %{
+        ready: true
+      },
+      properties: %{
+        ready: %Schema{
+          description: "Wanda platform ready",
+          type: :boolean
+        }
       }
-    }
-  })
+    },
+    struct?: false
+  )
 
   def response do
     Operation.response(

diff --git a/lib/wanda_web/schemas/v1/catalog/catalog_response.ex b/lib/wanda_web/schemas/v1/catalog/catalog_response.ex
@@ -8,13 +8,16 @@ defmodule WandaWeb.Schemas.V1.Catalog.CatalogResponse do
 
   require OpenApiSpex
 
-  OpenApiSpex.schema(%{
-    title: "CatalogResponse",
-    description: "Checks catalog listing response",
-    type: :object,
-    additionalProperties: false,
-    properties: %{
-      items: %Schema{type: :array, description: "List of catalog checks", items: Check}
-    }
-  })
+  OpenApiSpex.schema(
+    %{
+      title: "CatalogResponse",
+      description: "Checks catalog listing response",
+      type: :object,
+      additionalProperties: false,
+      properties: %{
+        items: %Schema{type: :array, description: "List of catalog checks", items: Check}
+      }
+    },
+    struct?: false
+  )
 end