Mirrors/VILLASweb-backend-go
1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/web-backend-go/ synced 2025-03-30 00:00:12 +01:00
Code Issues Releases Wiki Activity

Update API doc with swaggo

Browse source
This commit is contained in:
Sonja Happ 2020-11-11 16:34:06 +01:00
parent 392cb2fbff
commit d007781535
3 changed files with 47 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
doc/api/docs.go
View file

@ -1,6 +1,6 @@
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swaggo/swag at
// 2020-10-20 15:23:51.266197121 +0200 CEST m=+0.098130845
// 2020-11-11 16:32:47.799676915 +0100 CET m=+0.126448240
package docs
@ -1310,7 +1310,7 @@ var doc = `{
"application/json"
],
"tags": [
"AMQP"
"infrastructure-components"
],
"summary": "Send an action to IC (only available if backend server is started with -amqp parameter)",
"operationId": "sendActionToIC",
@ -2996,6 +2996,10 @@ var doc = `{
"description": "Location of the IC",
"type": "string"
},
"managedexternally": {
"description": "Boolean indicating if IC is managed externally (via AMQP/ VILLAScontroller)",
"type": "boolean"
},
"name": {
"description": "Name of the IC",
"type": "string"
@ -3018,7 +3022,7 @@ var doc = `{
},
"uptime": {
"description": "Uptime of the IC",
"type": "integer"
"type": "number"
},
"uuid": {
"description": "UUID of the IC",
@ -3377,9 +3381,9 @@ var doc = `{
"type": "object",
"required": [
"Category",
"ManagedExternally",
"Name",
"Type",
"UUID"
"Type"
],
"properties": {
"APIURL": {
@ -3394,6 +3398,9 @@ var doc = `{
"Location": {
"type": "string"
},
"ManagedExternally": {
"type": "boolean"
},
"Name": {
"type": "string"
},
@ -3409,6 +3416,9 @@ var doc = `{
"UUID": {
"type": "string"
},
"Uptime": {
"type": "number"
},
"WebsocketURL": {
"type": "string"
}
@ -3444,6 +3454,9 @@ var doc = `{
"UUID": {
"type": "string"
},
"Uptime": {
"type": "number"
},
"WebsocketURL": {
"type": "string"
}

21
doc/api/swagger.json
View file

@ -1293,7 +1293,7 @@
"application/json"
],
"tags": [
"AMQP"
"infrastructure-components"
],
"summary": "Send an action to IC (only available if backend server is started with -amqp parameter)",
"operationId": "sendActionToIC",
@ -2979,6 +2979,10 @@
"description": "Location of the IC",
"type": "string"
},
"managedexternally": {
"description": "Boolean indicating if IC is managed externally (via AMQP/ VILLAScontroller)",
"type": "boolean"
},
"name": {
"description": "Name of the IC",
"type": "string"
@ -3001,7 +3005,7 @@
},
"uptime": {
"description": "Uptime of the IC",
"type": "integer"
"type": "number"
},
"uuid": {
"description": "UUID of the IC",
@ -3360,9 +3364,9 @@
"type": "object",
"required": [
"Category",
"ManagedExternally",
"Name",
"Type",
"UUID"
"Type"
],
"properties": {
"APIURL": {
@ -3377,6 +3381,9 @@
"Location": {
"type": "string"
},
"ManagedExternally": {
"type": "boolean"
},
"Name": {
"type": "string"
},
@ -3392,6 +3399,9 @@
"UUID": {
"type": "string"
},
"Uptime": {
"type": "number"
},
"WebsocketURL": {
"type": "string"
}
@ -3427,6 +3437,9 @@
"UUID": {
"type": "string"
},
"Uptime": {
"type": "number"
},
"WebsocketURL": {
"type": "string"
}

15
doc/api/swagger.yaml
View file

@ -160,6 +160,9 @@ definitions:
location:
description: Location of the IC
type: string
managedexternally:
description: Boolean indicating if IC is managed externally (via AMQP/ VILLAScontroller)
type: boolean
name:
description: Name of the IC
type: string
@ -177,7 +180,7 @@ definitions:
type: string
uptime:
description: Uptime of the IC
type: integer
type: number
uuid:
description: UUID of the IC
type: string
@ -429,6 +432,8 @@ definitions:
type: string
Location:
type: string
ManagedExternally:
type: boolean
Name:
type: string
StartParameterScheme:
@ -439,13 +444,15 @@ definitions:
type: string
UUID:
type: string
Uptime:
type: number
WebsocketURL:
type: string
required:
- Category
- ManagedExternally
- Name
- Type
- UUID
type: object
infrastructure_component.validUpdatedIC:
properties:
@ -467,6 +474,8 @@ definitions:
type: string
UUID:
type: string
Uptime:
type: number
WebsocketURL:
type: string
type: object
@ -1558,7 +1567,7 @@ paths:
summary: Send an action to IC (only available if backend server is started with
-amqp parameter)
tags:
- AMQP
- infrastructure-components
/ic/{ICID}/configs:
get:
operationId: getConfigsOfIC