improved documentation

* added missing 'device_name' parameter to qrcodelink endpoint

see #95
This commit is contained in:
Bernhard B
2021-02-16 18:27:07 +01:00
parent 889f37d951
commit 1291a99087
4 changed files with 34 additions and 8 deletions

View File

@@ -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"
}
}