nathan/vctp2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated docs
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Nathan Coad
2026-02-06 16:01:01 +11:00
parent 0e3cf5aae9
commit 9677d083a8
6 changed files with 96 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
server/router/docs/docs.go
View File

@@ -185,6 +185,12 @@ const docTemplate = `{
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
@@ -201,7 +207,7 @@ const docTemplate = `{
"application/json"
],
"produces": [
"text/plain"
"application/json"
],
"tags": [
"events"
@@ -223,19 +229,19 @@ const docTemplate = `{
"200": {
"description": "Create event processed",
"schema": {
"type": "string"
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"type": "string"
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "string"
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -248,7 +254,7 @@ const docTemplate = `{
"application/json"
],
"produces": [
"text/plain"
"application/json"
],
"tags": [
"events"
@@ -270,19 +276,19 @@ const docTemplate = `{
"200": {
"description": "Delete event processed",
"schema": {
"type": "string"
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"type": "string"
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "string"
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -468,7 +474,7 @@ const docTemplate = `{
"post": {
"description": "Queries vCenter and updates inventory records with missing details.",
"produces": [
"text/plain"
"application/json"
],
"tags": [
"inventory"
@@ -478,13 +484,13 @@ const docTemplate = `{
"200": {
"description": "Update completed",
"schema": {
"type": "string"
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "string"
"$ref": "#/definitions/models.ErrorResponse"
}
}
}

28
server/router/docs/swagger.json
View File

@@ -174,6 +174,12 @@
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
@@ -190,7 +196,7 @@
"application/json"
],
"produces": [
"text/plain"
"application/json"
],
"tags": [
"events"
@@ -212,19 +218,19 @@
"200": {
"description": "Create event processed",
"schema": {
"type": "string"
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"type": "string"
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "string"
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -237,7 +243,7 @@
"application/json"
],
"produces": [
"text/plain"
"application/json"
],
"tags": [
"events"
@@ -259,19 +265,19 @@
"200": {
"description": "Delete event processed",
"schema": {
"type": "string"
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"type": "string"
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "string"
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -457,7 +463,7 @@
"post": {
"description": "Queries vCenter and updates inventory records with missing details.",
"produces": [
"text/plain"
"application/json"
],
"tags": [
"inventory"
@@ -467,13 +473,13 @@
"200": {
"description": "Update completed",
"schema": {
"type": "string"
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "string"
"$ref": "#/definitions/models.ErrorResponse"
}
}
}

26
server/router/docs/swagger.yaml
View File

@@ -405,6 +405,10 @@ paths:
description: Ciphertext response
schema:
$ref: '#/definitions/models.StatusMessageResponse'
"400":
description: Invalid request
schema:
$ref: '#/definitions/models.ErrorResponse'
"500":
description: Server error
schema:
@@ -427,20 +431,20 @@ paths:
schema:
$ref: '#/definitions/models.CloudEventReceived'
produces:
- text/plain
- application/json
responses:
"200":
description: Create event processed
schema:
type: string
$ref: '#/definitions/models.StatusMessageResponse'
"400":
description: Invalid request
schema:
type: string
$ref: '#/definitions/models.ErrorResponse'
"500":
description: Server error
schema:
type: string
$ref: '#/definitions/models.ErrorResponse'
summary: Record VM create event (deprecated)
tags:
- events
@@ -459,20 +463,20 @@ paths:
schema:
$ref: '#/definitions/models.CloudEventReceived'
produces:
- text/plain
- application/json
responses:
"200":
description: Delete event processed
schema:
type: string
$ref: '#/definitions/models.StatusMessageResponse'
"400":
description: Invalid request
schema:
type: string
$ref: '#/definitions/models.ErrorResponse'
"500":
description: Server error
schema:
type: string
$ref: '#/definitions/models.ErrorResponse'
summary: Record VM delete event (deprecated)
tags:
- events
@@ -598,16 +602,16 @@ paths:
post:
description: Queries vCenter and updates inventory records with missing details.
produces:
- text/plain
- application/json
responses:
"200":
description: Update completed
schema:
type: string
$ref: '#/definitions/models.StatusMessageResponse'
"500":
description: Server error
schema:
type: string
$ref: '#/definitions/models.ErrorResponse'
summary: Refresh VM details
tags:
- inventory