aljaz/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/aljazceru/signal-cli-rest-api.git synced 2026-02-23 16:04:39 +01:00
Code Issues Packages Projects Releases Wiki Activity

fixed swagger documentation

Browse Source 
* some endpoints had a wrong HTTP status code in the swagger
  documentation.

see #175
This commit is contained in:
Bernhard B
2021-11-01 17:15:54 +01:00
parent 2d80ff91a2
commit d4b2dbea7f
4 changed files with 39 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/api/api.go
View File

@@ -742,7 +742,7 @@ func (a *Api) TrustIdentity(c *gin.Context) {
// @Description Set the REST API configuration. // @Description Set the REST API configuration.
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 201 {string} string "OK" // @Success 204 {string} string "OK"
// @Failure 400 {object} Error // @Failure 400 {object} Error
// @Param data body Configuration true "Configuration" // @Param data body Configuration true "Configuration"
// @Router /v1/configuration [post] // @Router /v1/configuration [post]
@@ -797,7 +797,7 @@ func (a *Api) GetConfiguration(c *gin.Context) {
// @Description Block the specified Signal Group. // @Description Block the specified Signal Group.
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {string} OK // @Success 204 {string} OK
// @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 groupid path string true "Group ID" // @Param groupid path string true "Group ID"
@@ -830,7 +830,7 @@ func (a *Api) BlockGroup(c *gin.Context) {
// @Description Join the specified Signal Group. // @Description Join the specified Signal Group.
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {string} OK // @Success 204 {string} OK
// @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 groupid path string true "Group ID" // @Param groupid path string true "Group ID"
@@ -863,7 +863,7 @@ func (a *Api) JoinGroup(c *gin.Context) {
// @Description Quit the specified Signal Group. // @Description Quit the specified Signal Group.
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {string} OK // @Success 204 {string} OK
// @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 groupid path string true "Group ID" // @Param groupid path string true "Group ID"
@@ -895,7 +895,7 @@ func (a *Api) QuitGroup(c *gin.Context) {
// @Description Show Typing Indicator. // @Description Show Typing Indicator.
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 201 {string} OK // @Success 204 {string} OK
// @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 data body TypingIndicatorRequest true "Type" // @Param data body TypingIndicatorRequest true "Type"
@@ -928,7 +928,7 @@ func (a *Api) SendStartTyping(c *gin.Context) {
// @Description Hide Typing Indicator. // @Description Hide Typing Indicator.
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 201 {string} OK // @Success 204 {string} OK
// @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 data body TypingIndicatorRequest true "Type" // @Param data body TypingIndicatorRequest true "Type"

22
src/docs/docs.go
View File

@@ -194,7 +194,7 @@ var doc = `{
} }
], ],
"responses": { "responses": {
"201": { "204": {
"description": "OK", "description": "OK",
"schema": { "schema": {
"type": "string" "type": "string"
@@ -413,8 +413,8 @@ var doc = `{
} }
], ],
"responses": { "responses": {
"200": { "204": {
"description": "OK", "description": "No Content",
"schema": { "schema": {
"type": "string" "type": "string"
} }
@@ -458,8 +458,8 @@ var doc = `{
} }
], ],
"responses": { "responses": {
"200": { "204": {
"description": "OK", "description": "No Content",
"schema": { "schema": {
"type": "string" "type": "string"
} }
@@ -503,8 +503,8 @@ var doc = `{
} }
], ],
"responses": { "responses": {
"200": { "204": {
"description": "OK", "description": "No Content",
"schema": { "schema": {
"type": "string" "type": "string"
} }
@@ -908,8 +908,8 @@ var doc = `{
} }
], ],
"responses": { "responses": {
"201": { "204": {
"description": "Created", "description": "No Content",
"schema": { "schema": {
"type": "string" "type": "string"
} }
@@ -953,8 +953,8 @@ var doc = `{
} }
], ],
"responses": { "responses": {
"201": { "204": {
"description": "Created", "description": "No Content",
"schema": { "schema": {
"type": "string" "type": "string"
} }

22
src/docs/swagger.json
View File

@@ -179,7 +179,7 @@
} }
], ],
"responses": { "responses": {
"201": { "204": {
"description": "OK", "description": "OK",
"schema": { "schema": {
"type": "string" "type": "string"
@@ -398,8 +398,8 @@
} }
], ],
"responses": { "responses": {
"200": { "204": {
"description": "OK", "description": "No Content",
"schema": { "schema": {
"type": "string" "type": "string"
} }
@@ -443,8 +443,8 @@
} }
], ],
"responses": { "responses": {
"200": { "204": {
"description": "OK", "description": "No Content",
"schema": { "schema": {
"type": "string" "type": "string"
} }
@@ -488,8 +488,8 @@
} }
], ],
"responses": { "responses": {
"200": { "204": {
"description": "OK", "description": "No Content",
"schema": { "schema": {
"type": "string" "type": "string"
} }
@@ -893,8 +893,8 @@
} }
], ],
"responses": { "responses": {
"201": { "204": {
"description": "Created", "description": "No Content",
"schema": { "schema": {
"type": "string" "type": "string"
} }
@@ -938,8 +938,8 @@
} }
], ],
"responses": { "responses": {
"201": { "204": {
"description": "Created", "description": "No Content",
"schema": { "schema": {
"type": "string" "type": "string"
} }

22
src/docs/swagger.yaml
View File

@@ -285,7 +285,7 @@ paths:
produces: produces:
- application/json - application/json
responses: responses:
"201": "204":
description: OK description: OK
schema: schema:
type: string type: string
@@ -431,8 +431,8 @@ paths:
produces: produces:
- application/json - application/json
responses: responses:
"200": "204":
description: OK description: No Content
schema: schema:
type: string type: string
"400": "400":
@@ -461,8 +461,8 @@ paths:
produces: produces:
- application/json - application/json
responses: responses:
"200": "204":
description: OK description: No Content
schema: schema:
type: string type: string
"400": "400":
@@ -491,8 +491,8 @@ paths:
produces: produces:
- application/json - application/json
responses: responses:
"200": "204":
description: OK description: No Content
schema: schema:
type: string type: string
"400": "400":
@@ -758,8 +758,8 @@ paths:
produces: produces:
- application/json - application/json
responses: responses:
"201": "204":
description: Created description: No Content
schema: schema:
type: string type: string
"400": "400":
@@ -788,8 +788,8 @@ paths:
produces: produces:
- application/json - application/json
responses: responses:
"201": "204":
description: Created description: No Content
schema: schema:
type: string type: string
"400": "400":