unify path params in openapi

meteroid-oss · Dec 24, 2024 · 12ee064 · 12ee064
1 parent 4d842f8
commit 12ee064
Show file tree

Hide file tree

Showing 6 changed files with 59 additions and 19 deletions.
diff --git a/modules/meteroid/src/api_rest/files/mod.rs b/modules/meteroid/src/api_rest/files/mod.rs
@@ -8,6 +8,6 @@ pub use router::FileApi;
 
 pub fn file_routes() -> Router<AppState> {
     Router::new()
-        .route("/v1/logo/:uuid", get(router::get_logo))
+        .route("/v1/logo/{uuid}", get(router::get_logo))
         .route("/v1/invoice/pdf/:uuid", get(router::get_invoice_pdf))
 }
diff --git a/modules/meteroid/src/api_rest/files/router.rs b/modules/meteroid/src/api_rest/files/router.rs
@@ -28,7 +28,7 @@ pub struct FileApi;
 #[utoipa::path(
     get,
     tag = "file",
-    path = "/v1/logo/{uuid}",
+    path = "/v1/logo/:uuid",
     params(
         ("uuid" = Uuid, Path, description = "Logo database UUID")
     ),
@@ -83,9 +83,9 @@ pub struct TokenParams {
 #[utoipa::path(
     get,
     tag = "file",
-    path = "/v1/invoice/pdf/{uid}",
+    path = "/v1/invoice/pdf/:uid",
     params(
-        ("uuid" = String, Path, description = "Invoice database UID"),
+        ("uid" = String, Path, description = "Invoice database UID"),
         ("token" = str, Query, description = "Security token"),
     ),
     responses(

diff --git a/modules/meteroid/src/api_rest/plans/router.rs b/modules/meteroid/src/api_rest/plans/router.rs
@@ -27,7 +27,11 @@ use uuid::Uuid;
     ),
     responses(
         (status = 200, description = "List of plans", body = PaginatedResponse<Plan>),
+        (status = 401, description = "Unauthorized"),
         (status = 500, description = "Internal error"),
+    ),
+    security(
+        ("api-key" = [])
     )
 )]
 #[axum::debug_handler]

diff --git a/modules/meteroid/src/api_rest/productfamilies/router.rs b/modules/meteroid/src/api_rest/productfamilies/router.rs
@@ -21,7 +21,11 @@ use uuid::Uuid;
     ),
     responses(
         (status = 200, description = "List of product families", body = PaginatedResponse<ProductFamily>),
+        (status = 401, description = "Unauthorized"),
         (status = 500, description = "Internal error"),
+    ),
+    security(
+        ("api-key" = [])
     )
 )]
 #[axum::debug_handler]

diff --git a/modules/meteroid/src/api_rest/subscriptions/router.rs b/modules/meteroid/src/api_rest/subscriptions/router.rs
@@ -27,7 +27,11 @@ use uuid::Uuid;
     ),
     responses(
         (status = 200, description = "List of subscriptions", body = PaginatedResponse<Subscription>),
+        (status = 401, description = "Unauthorized"),
         (status = 500, description = "Internal error"),
+    ),
+    security(
+        ("api-key" = [])
     )
 )]
 #[axum::debug_handler]
@@ -96,7 +100,11 @@ async fn list_subscriptions_handler(
     ),
     responses(
         (status = 200, description = "Details of subscription", body = SubscriptionDetails),
+        (status = 401, description = "Unauthorized"),
         (status = 500, description = "Internal error"),
+    ),
+    security(
+        ("api-key" = [])
     )
 )]
 #[axum::debug_handler]

diff --git a/spec/api/v1/openapi.json b/spec/api/v1/openapi.json
@@ -226,10 +226,18 @@
               }
             }
           },
+          "401": {
+            "description": "Unauthorized"
+          },
           "500": {
             "description": "Internal error"
           }
-        }
+        },
+        "security": [
+          {
+            "api-key": []
+          }
+        ]
       }
     },
     "/api/v1/product_families": {
@@ -249,10 +257,18 @@
               }
             }
           },
+          "401": {
+            "description": "Unauthorized"
+          },
           "500": {
             "description": "Internal error"
           }
-        }
+        },
+        "security": [
+          {
+            "api-key": []
+          }
+        ]
       }
     },
     "/api/v1/subscriptions": {
@@ -296,10 +312,18 @@
               }
             }
           },
+          "401": {
+            "description": "Unauthorized"
+          },
           "500": {
             "description": "Internal error"
           }
-        }
+        },
+        "security": [
+          {
+            "api-key": []
+          }
+        ]
       }
     },
     "/api/v1/subscriptions/:id": {
@@ -330,21 +354,29 @@
               }
             }
           },
+          "401": {
+            "description": "Unauthorized"
+          },
           "500": {
             "description": "Internal error"
           }
-        }
+        },
+        "security": [
+          {
+            "api-key": []
+          }
+        ]
       }
     },
-    "/files/v1/invoice/pdf/{uid}": {
+    "/files/v1/invoice/pdf/:uid": {
       "get": {
         "tags": [
           "file"
         ],
         "operationId": "get_invoice_pdf",
         "parameters": [
           {
-            "name": "uuid",
+            "name": "uid",
             "in": "path",
             "description": "Invoice database UID",
             "required": true,
@@ -360,14 +392,6 @@
             "schema": {
               "type": "string"
             }
-          },
-          {
-            "name": "uid",
-            "in": "path",
-            "required": true,
-            "schema": {
-              "type": "string"
-            }
           }
         ],
         "responses": {
@@ -398,7 +422,7 @@
         }
       }
     },
-    "/files/v1/logo/{uuid}": {
+    "/files/v1/logo/:uuid": {
       "get": {
         "tags": [
           "file"