mirror of
https://github.com/aljazceru/signal-cli-rest-api.git
synced 2025-12-19 15:44:28 +01:00
updated swagger documentation
* added documentation for timeout parameter in receive endpoint
This commit is contained in:
@@ -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")
|
||||
|
||||
@@ -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": {
|
||||
|
||||
@@ -198,6 +198,12 @@
|
||||
"name": "number",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Receive timeout in seconds (default: 1)",
|
||||
"name": "timeout",
|
||||
"in": "query"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
|
||||
@@ -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:
|
||||
|
||||
Reference in New Issue
Block a user