chore: generate openapi specs for organization endpoint for v1 and v2 (#5648)

Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>

api-reference-v2/openapi_spec.json

@@ -20,6 +20,150 @@
     }
   ],
   "paths": {
+    "/organization": {
+      "post": {
+        "tags": [
+          "Organization"
+        ],
+        "summary": "Organization - Create",
+        "description": "Organization - Create\n\nCreate a new organization",
+        "operationId": "Create an Organization",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/OrganizationRequest"
+              },
+              "examples": {
+                "Create an organization with organization_name": {
+                  "value": {
+                    "organization_name": "organization_abc"
+                  }
+                }
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Organization Created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OrganizationResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid data"
+          }
+        },
+        "security": [
+          {
+            "admin_api_key": []
+          }
+        ]
+      }
+    },
+    "/organization/{organization_id}": {
+      "get": {
+        "tags": [
+          "Organization"
+        ],
+        "summary": "Organization - Retrieve",
+        "description": "Organization - Retrieve\n\nRetrieve an existing organization",
+        "operationId": "Retrieve an Organization",
+        "parameters": [
+          {
+            "name": "organization_id",
+            "in": "path",
+            "description": "The unique identifier for the Organization",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Organization Created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OrganizationResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid data"
+          }
+        },
+        "security": [
+          {
+            "admin_api_key": []
+          }
+        ]
+      },
+      "put": {
+        "tags": [
+          "Organization"
+        ],
+        "summary": "Organization - Update",
+        "description": "Organization - Update\n\nCreate a new organization for .",
+        "operationId": "Update an Organization",
+        "parameters": [
+          {
+            "name": "organization_id",
+            "in": "path",
+            "description": "The unique identifier for the Organization",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/OrganizationRequest"
+              },
+              "examples": {
+                "Update organization_name of the organization": {
+                  "value": {
+                    "organization_name": "organization_abcd"
+                  }
+                }
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Organization Created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OrganizationResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid data"
+          }
+        },
+        "security": [
+          {
+            "admin_api_key": []
+          }
+        ]
+      }
+    },
     "/v2/connector_accounts": {
       "post": {
         "tags": [

api-reference/api-reference/organization/organization--create.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /organization
+---

api-reference/api-reference/organization/organization--retrieve.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /organization/{organization_id}
+---

api-reference/api-reference/organization/organization--update.mdx

@@ -0,0 +1,3 @@
+---
+openapi: put /organization/{organization_id}
+---

api-reference/mint.json

@@ -103,6 +103,14 @@
         "api-reference/disputes/disputes--list"
       ]
     },
+    {
+      "group": "Organization",
+      "pages": [
+        "api-reference/organization/organization--create",
+        "api-reference/organization/organization--retrieve",
+        "api-reference/organization/organization--update"
+      ]
+    },
     {
       "group": "Merchant Account",
       "pages": [

api-reference/openapi_spec.json

@@ -1157,13 +1157,52 @@
       }
     },
     "/organization/{organization_id}": {
-      "post": {
+      "get": {
+        "tags": [
+          "Organization"
+        ],
+        "summary": "Organization - Retrieve",
+        "description": "Organization - Retrieve\n\nRetrieve an existing organization",
+        "operationId": "Retrieve an Organization",
+        "parameters": [
+          {
+            "name": "organization_id",
+            "in": "path",
+            "description": "The unique identifier for the Organization",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Organization Created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OrganizationResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid data"
+          }
+        },
+        "security": [
+          {
+            "admin_api_key": []
+          }
+        ]
+      },
+      "put": {
         "tags": [
           "Organization"
         ],
         "summary": "Organization - Update",
         "description": "Organization - Update\n\nCreate a new organization for .",
-        "operationId": "Create an Organization",
+        "operationId": "Update an Organization",
         "parameters": [
           {
             "name": "organization_id",

crates/openapi/src/openapi_v2.rs

@@ -69,6 +69,11 @@ Never share your secret api keys. Keep them guarded and secure.
     ),
     // The paths will be displayed in the same order as they are registered here
     paths(
+        // Routes for Organization
+        routes::organization::organization_create,
+        routes::organization::organization_retrieve,
+        routes::organization::organization_update,
+
         // Routes for merchant connector account
         routes::merchant_connector_account::connector_create,
         routes::merchant_connector_account::connector_retrieve,

crates/openapi/src/routes/organization.rs

@@ -1,3 +1,4 @@
+#[cfg(any(feature = "v1", feature = "v2"))]
 /// Organization - Create
 ///
 /// Create a new organization
@@ -24,11 +25,12 @@
 )]
 pub async fn organization_create() {}
 
+#[cfg(any(feature = "v1", feature = "v2"))]
 /// Organization - Retrieve
 ///
 /// Retrieve an existing organization
 #[utoipa::path(
-    post,
+    get,
     path = "/organization/{organization_id}",
     params (("organization_id" = String, Path, description = "The unique identifier for the Organization")),
     responses(
@@ -36,16 +38,17 @@ pub async fn organization_create() {}
         (status = 400, description = "Invalid data")
     ),
     tag = "Organization",
-    operation_id = "Create an Organization",
+    operation_id = "Retrieve an Organization",
     security(("admin_api_key" = []))
 )]
 pub async fn organization_retrieve() {}
 
+#[cfg(any(feature = "v1", feature = "v2"))]
 /// Organization - Update
 ///
 /// Create a new organization for .
 #[utoipa::path(
-    post,
+    put,
     path = "/organization/{organization_id}",
     request_body(
         content = OrganizationRequest,
@@ -63,7 +66,7 @@ pub async fn organization_retrieve() {}
         (status = 400, description = "Invalid data")
     ),
     tag = "Organization",
-    operation_id = "Create an Organization",
+    operation_id = "Update an Organization",
     security(("admin_api_key" = []))
 )]
 pub async fn organization_update() {}