diff --git a/src/api/api.go b/src/api/api.go index fbcc783..9b87642 100644 --- a/src/api/api.go +++ b/src/api/api.go @@ -745,6 +745,7 @@ func (a *Api) DeleteGroup(c *gin.Context) { // @Description Link device and generate QR code // @Produce json // @Success 200 {string} string "Image" +// @Param device_name query string true "Device Name" // @Failure 400 {object} Error // @Router /v1/qrcodelink [get] func (a *Api) GetQrCodeLink(c *gin.Context) { diff --git a/src/docs/docs.go b/src/docs/docs.go index 811ea13..0328e8d 100644 --- a/src/docs/docs.go +++ b/src/docs/docs.go @@ -19,6 +19,7 @@ var doc = `{ "description": "{{.Description}}", "title": "{{.Title}}", "contact": {}, + "license": {}, "version": "{{.Version}}" }, "host": "{{.Host}}", @@ -659,6 +660,15 @@ var doc = `{ "Devices" ], "summary": "Link device and generate QR code.", + "parameters": [ + { + "type": "string", + "description": "Device Name", + "name": "device_name", + "in": "query", + "required": true + } + ], "responses": { "200": { "description": "Image", @@ -753,9 +763,7 @@ var doc = `{ } ], "responses": { - "201": { - "description": "" - }, + "201": {}, "400": { "description": "Bad Request", "schema": { @@ -919,6 +927,7 @@ var doc = `{ "type": "object", "properties": { "logging": { + "type": "object", "$ref": "#/definitions/api.LoggingConfiguration" } } diff --git a/src/docs/swagger.json b/src/docs/swagger.json index 321dc93..8585c45 100644 --- a/src/docs/swagger.json +++ b/src/docs/swagger.json @@ -4,6 +4,7 @@ "description": "This is the Signal Cli REST API documentation.", "title": "Signal Cli REST API", "contact": {}, + "license": {}, "version": "1.0" }, "host": "127.0.0.1:8080", @@ -644,6 +645,15 @@ "Devices" ], "summary": "Link device and generate QR code.", + "parameters": [ + { + "type": "string", + "description": "Device Name", + "name": "device_name", + "in": "query", + "required": true + } + ], "responses": { "200": { "description": "Image", @@ -738,9 +748,7 @@ } ], "responses": { - "201": { - "description": "" - }, + "201": {}, "400": { "description": "Bad Request", "schema": { @@ -904,6 +912,7 @@ "type": "object", "properties": { "logging": { + "type": "object", "$ref": "#/definitions/api.LoggingConfiguration" } } diff --git a/src/docs/swagger.yaml b/src/docs/swagger.yaml index 29b5897..d985659 100644 --- a/src/docs/swagger.yaml +++ b/src/docs/swagger.yaml @@ -13,6 +13,7 @@ definitions: properties: logging: $ref: '#/definitions/api.LoggingConfiguration' + type: object type: object api.CreateGroup: properties: @@ -125,6 +126,7 @@ host: 127.0.0.1:8080 info: contact: {} description: This is the Signal Cli REST API documentation. + license: {} title: Signal Cli REST API version: "1.0" paths: @@ -545,6 +547,12 @@ paths: /v1/qrcodelink: get: description: Link device and generate QR code + parameters: + - description: Device Name + in: query + name: device_name + required: true + type: string produces: - application/json responses: @@ -609,8 +617,7 @@ paths: produces: - application/json responses: - "201": - description: "" + "201": {} "400": description: Bad Request schema: