Updated Swagger Documentation

2025-03-24 15:15:31 +01:00
parent 67dfc32e4a
commit 9684d6dd29
56 changed files with 1344 additions and 349 deletions
@@ -3,9 +3,9 @@
      "tags": [
        "BulkSMS"
      ],
-      "summary": "BulkSMS Request",
-      "description": "BulkSMS Request",
-      "operationId": "BulkSMS",
+      "summary": "Send Bulk SMS",
+      "description": "This request is used to send Bulk SMS messages to multiple customers. The max length of the array should equal 20. The API is hosted in FIRSTBANK and it is the HTTP wrapper for the real SMS sending interface.",
+      "operationId": "bulkSmsNotification",
      "requestBody": {
        "required": true,
        "content": {
@@ -28,7 +28,7 @@
      },
      "responses": {
        "200": {
-          "description": "BulkSMS Successful",
+          "description": "Bulk SMS sent successfully",
          "content": {
            "application/json": {
              "schema": {
@@ -43,11 +43,16 @@
          }
        },
        "400": {
-          "description": "Invalid request"
+          "description": "Unsuccessful Response with Client Error"
        },
        "500": {
          "description": "Internal server error"
        }
-      }
+      },
+      "security": [
+        {
+          "api_key": []
+        }
+      ]
    }
-  }
+}