updated swagger documentation

* added documentation for timeout parameter in receive endpoint
This commit is contained in:
Bernhard B
2020-11-01 21:47:25 +01:00
parent 7674dbcdb8
commit 418b93459f
4 changed files with 17 additions and 0 deletions

View File

@@ -487,6 +487,7 @@ func (a *Api) SendV2(c *gin.Context) {
// @Success 200 {object} []string // @Success 200 {object} []string
// @Failure 400 {object} Error // @Failure 400 {object} Error
// @Param number path string true "Registered Phone Number" // @Param number path string true "Registered Phone Number"
// @Param timeout query string false "Receive timeout in seconds (default: 1)"
// @Router /v1/receive/{number} [get] // @Router /v1/receive/{number} [get]
func (a *Api) Receive(c *gin.Context) { func (a *Api) Receive(c *gin.Context) {
number := c.Param("number") number := c.Param("number")

View File

@@ -213,6 +213,12 @@ var doc = `{
"name": "number", "name": "number",
"in": "path", "in": "path",
"required": true "required": true
},
{
"type": "string",
"description": "Receive timeout in seconds (default: 1)",
"name": "timeout",
"in": "query"
} }
], ],
"responses": { "responses": {

View File

@@ -198,6 +198,12 @@
"name": "number", "name": "number",
"in": "path", "in": "path",
"required": true "required": true
},
{
"type": "string",
"description": "Receive timeout in seconds (default: 1)",
"name": "timeout",
"in": "query"
} }
], ],
"responses": { "responses": {

View File

@@ -201,6 +201,10 @@ paths:
name: number name: number
required: true required: true
type: string type: string
- description: 'Receive timeout in seconds (default: 1)'
in: query
name: timeout
type: string
produces: produces:
- application/json - application/json
responses: responses: