feat(SPV-1345): swagger

bitcoin-sv · Jan 2, 2025 · e3b6b2a · e3b6b2a
1 parent 00cce43
commit e3b6b2a
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 0 deletions.
diff --git a/docs/docs.go b/docs/docs.go
@@ -803,6 +803,35 @@ const docTemplate = `{
             }
         },
         "/api/v1/admin/webhooks/subscriptions": {
+            "get": {
+                "security": [
+                    {
+                        "x-auth-xpub": []
+                    }
+                ],
+                "description": "Get All Webhooks currently subscribed to",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Admin"
+                ],
+                "summary": "Get All Webhooks",
+                "responses": {
+                    "200": {
+                        "description": "List of webhooks",
+                        "schema": {
+                            "type": "array",
+                            "items": {
+                                "$ref": "#/definitions/models.Webhook"
+                            }
+                        }
+                    },
+                    "500": {
+                        "description": "Internal server error - Error while getting all webhooks"
+                    }
+                }
+            },
             "post": {
                 "security": [
                     {

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -794,6 +794,35 @@
             }
         },
         "/api/v1/admin/webhooks/subscriptions": {
+            "get": {
+                "security": [
+                    {
+                        "x-auth-xpub": []
+                    }
+                ],
+                "description": "Get All Webhooks currently subscribed to",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Admin"
+                ],
+                "summary": "Get All Webhooks",
+                "responses": {
+                    "200": {
+                        "description": "List of webhooks",
+                        "schema": {
+                            "type": "array",
+                            "items": {
+                                "$ref": "#/definitions/models.Webhook"
+                            }
+                        }
+                    },
+                    "500": {
+                        "description": "Internal server error - Error while getting all webhooks"
+                    }
+                }
+            },
             "post": {
                 "security": [
                     {

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -3277,6 +3277,24 @@ paths:
       summary: Unsubscribe to a webhook
       tags:
       - Admin
+    get:
+      description: Get All Webhooks currently subscribed to
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: List of webhooks
+          schema:
+            items:
+              $ref: '#/definitions/models.Webhook'
+            type: array
+        "500":
+          description: Internal server error - Error while getting all webhooks
+      security:
+      - x-auth-xpub: []
+      summary: Get All Webhooks
+      tags:
+      - Admin
     post:
       description: Subscribe to a webhook to receive notifications
       parameters: