From 418b93459f099afd626d75a0ebbc2fd40c8cb584 Mon Sep 17 00:00:00 2001
From: Bernhard B <schluchti@gmail.com>
Date: Sun, 1 Nov 2020 21:47:25 +0100
Subject: [PATCH] updated swagger documentation

* added documentation for timeout parameter in receive endpoint
---
 src/api/api.go        | 1 +
 src/docs/docs.go      | 6 ++++++
 src/docs/swagger.json | 6 ++++++
 src/docs/swagger.yaml | 4 ++++
 4 files changed, 17 insertions(+)

diff --git a/src/api/api.go b/src/api/api.go
index 3314775..d1c0937 100644
--- a/src/api/api.go
+++ b/src/api/api.go
@@ -487,6 +487,7 @@ func (a *Api) SendV2(c *gin.Context) {
 // @Success 200 {object} []string
 // @Failure 400 {object} Error
 // @Param number path string true "Registered Phone Number"
+// @Param timeout query string false "Receive timeout in seconds (default: 1)"
 // @Router /v1/receive/{number} [get]
 func (a *Api) Receive(c *gin.Context) {
 	number := c.Param("number")
diff --git a/src/docs/docs.go b/src/docs/docs.go
index d4d99fe..7d3d95f 100644
--- a/src/docs/docs.go
+++ b/src/docs/docs.go
@@ -213,6 +213,12 @@ var doc = `{
                         "name": "number",
                         "in": "path",
                         "required": true
+                    },
+                    {
+                        "type": "string",
+                        "description": "Receive timeout in seconds (default: 1)",
+                        "name": "timeout",
+                        "in": "query"
                     }
                 ],
                 "responses": {
diff --git a/src/docs/swagger.json b/src/docs/swagger.json
index b019467..9199551 100644
--- a/src/docs/swagger.json
+++ b/src/docs/swagger.json
@@ -198,6 +198,12 @@
                         "name": "number",
                         "in": "path",
                         "required": true
+                    },
+                    {
+                        "type": "string",
+                        "description": "Receive timeout in seconds (default: 1)",
+                        "name": "timeout",
+                        "in": "query"
                     }
                 ],
                 "responses": {
diff --git a/src/docs/swagger.yaml b/src/docs/swagger.yaml
index 25b9474..e94efb9 100644
--- a/src/docs/swagger.yaml
+++ b/src/docs/swagger.yaml
@@ -201,6 +201,10 @@ paths:
         name: number
         required: true
         type: string
+      - description: 'Receive timeout in seconds (default: 1)'
+        in: query
+        name: timeout
+        type: string
       produces:
       - application/json
       responses: