From d4b2dbea7f5c7aab75fd34628ffb00e373400653 Mon Sep 17 00:00:00 2001 From: Bernhard B Date: Mon, 1 Nov 2021 17:15:54 +0100 Subject: [PATCH] fixed swagger documentation * some endpoints had a wrong HTTP status code in the swagger documentation. see #175 --- src/api/api.go | 12 ++++++------ src/docs/docs.go | 22 +++++++++++----------- src/docs/swagger.json | 22 +++++++++++----------- src/docs/swagger.yaml | 22 +++++++++++----------- 4 files changed, 39 insertions(+), 39 deletions(-) diff --git a/src/api/api.go b/src/api/api.go index 6819b3c..00fc0cc 100644 --- a/src/api/api.go +++ b/src/api/api.go @@ -742,7 +742,7 @@ func (a *Api) TrustIdentity(c *gin.Context) { // @Description Set the REST API configuration. // @Accept json // @Produce json -// @Success 201 {string} string "OK" +// @Success 204 {string} string "OK" // @Failure 400 {object} Error // @Param data body Configuration true "Configuration" // @Router /v1/configuration [post] @@ -797,7 +797,7 @@ func (a *Api) GetConfiguration(c *gin.Context) { // @Description Block the specified Signal Group. // @Accept json // @Produce json -// @Success 200 {string} OK +// @Success 204 {string} OK // @Failure 400 {object} Error // @Param number path string true "Registered Phone Number" // @Param groupid path string true "Group ID" @@ -830,7 +830,7 @@ func (a *Api) BlockGroup(c *gin.Context) { // @Description Join the specified Signal Group. // @Accept json // @Produce json -// @Success 200 {string} OK +// @Success 204 {string} OK // @Failure 400 {object} Error // @Param number path string true "Registered Phone Number" // @Param groupid path string true "Group ID" @@ -863,7 +863,7 @@ func (a *Api) JoinGroup(c *gin.Context) { // @Description Quit the specified Signal Group. // @Accept json // @Produce json -// @Success 200 {string} OK +// @Success 204 {string} OK // @Failure 400 {object} Error // @Param number path string true "Registered Phone Number" // @Param groupid path string true "Group ID" @@ -895,7 +895,7 @@ func (a *Api) QuitGroup(c *gin.Context) { // @Description Show Typing Indicator. // @Accept json // @Produce json -// @Success 201 {string} OK +// @Success 204 {string} OK // @Failure 400 {object} Error // @Param number path string true "Registered Phone Number" // @Param data body TypingIndicatorRequest true "Type" @@ -928,7 +928,7 @@ func (a *Api) SendStartTyping(c *gin.Context) { // @Description Hide Typing Indicator. // @Accept json // @Produce json -// @Success 201 {string} OK +// @Success 204 {string} OK // @Failure 400 {object} Error // @Param number path string true "Registered Phone Number" // @Param data body TypingIndicatorRequest true "Type" diff --git a/src/docs/docs.go b/src/docs/docs.go index 0ae64c5..0f8cdaf 100644 --- a/src/docs/docs.go +++ b/src/docs/docs.go @@ -194,7 +194,7 @@ var doc = `{ } ], "responses": { - "201": { + "204": { "description": "OK", "schema": { "type": "string" @@ -413,8 +413,8 @@ var doc = `{ } ], "responses": { - "200": { - "description": "OK", + "204": { + "description": "No Content", "schema": { "type": "string" } @@ -458,8 +458,8 @@ var doc = `{ } ], "responses": { - "200": { - "description": "OK", + "204": { + "description": "No Content", "schema": { "type": "string" } @@ -503,8 +503,8 @@ var doc = `{ } ], "responses": { - "200": { - "description": "OK", + "204": { + "description": "No Content", "schema": { "type": "string" } @@ -908,8 +908,8 @@ var doc = `{ } ], "responses": { - "201": { - "description": "Created", + "204": { + "description": "No Content", "schema": { "type": "string" } @@ -953,8 +953,8 @@ var doc = `{ } ], "responses": { - "201": { - "description": "Created", + "204": { + "description": "No Content", "schema": { "type": "string" } diff --git a/src/docs/swagger.json b/src/docs/swagger.json index 4d58533..79e3b55 100644 --- a/src/docs/swagger.json +++ b/src/docs/swagger.json @@ -179,7 +179,7 @@ } ], "responses": { - "201": { + "204": { "description": "OK", "schema": { "type": "string" @@ -398,8 +398,8 @@ } ], "responses": { - "200": { - "description": "OK", + "204": { + "description": "No Content", "schema": { "type": "string" } @@ -443,8 +443,8 @@ } ], "responses": { - "200": { - "description": "OK", + "204": { + "description": "No Content", "schema": { "type": "string" } @@ -488,8 +488,8 @@ } ], "responses": { - "200": { - "description": "OK", + "204": { + "description": "No Content", "schema": { "type": "string" } @@ -893,8 +893,8 @@ } ], "responses": { - "201": { - "description": "Created", + "204": { + "description": "No Content", "schema": { "type": "string" } @@ -938,8 +938,8 @@ } ], "responses": { - "201": { - "description": "Created", + "204": { + "description": "No Content", "schema": { "type": "string" } diff --git a/src/docs/swagger.yaml b/src/docs/swagger.yaml index 9b7aee6..018087e 100644 --- a/src/docs/swagger.yaml +++ b/src/docs/swagger.yaml @@ -285,7 +285,7 @@ paths: produces: - application/json responses: - "201": + "204": description: OK schema: type: string @@ -431,8 +431,8 @@ paths: produces: - application/json responses: - "200": - description: OK + "204": + description: No Content schema: type: string "400": @@ -461,8 +461,8 @@ paths: produces: - application/json responses: - "200": - description: OK + "204": + description: No Content schema: type: string "400": @@ -491,8 +491,8 @@ paths: produces: - application/json responses: - "200": - description: OK + "204": + description: No Content schema: type: string "400": @@ -758,8 +758,8 @@ paths: produces: - application/json responses: - "201": - description: Created + "204": + description: No Content schema: type: string "400": @@ -788,8 +788,8 @@ paths: produces: - application/json responses: - "201": - description: Created + "204": + description: No Content schema: type: string "400":