Update API doc with swaggo

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

View file

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

View file

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

View file

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