add more documentation
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
2026-01-22 20:30:02 +11:00
parent 68ee2838e4
commit c8f04efd51
7 changed files with 500 additions and 325 deletions

View File

@@ -92,19 +92,13 @@ const docTemplate = `{
"200": {
"description": "Cleanup completed",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -141,19 +135,13 @@ const docTemplate = `{
"200": {
"description": "Ciphertext response",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -282,28 +270,19 @@ const docTemplate = `{
"200": {
"description": "Modify event processed",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"202": {
"description": "No relevant changes",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -338,28 +317,19 @@ const docTemplate = `{
"200": {
"description": "Move event processed",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -393,19 +363,13 @@ const docTemplate = `{
"200": {
"description": "Import processed",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -441,19 +405,13 @@ const docTemplate = `{
"200": {
"description": "Cleanup completed",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -505,10 +463,7 @@ const docTemplate = `{
"500": {
"description": "Report generation failed",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -543,19 +498,13 @@ const docTemplate = `{
"400": {
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -581,10 +530,7 @@ const docTemplate = `{
"500": {
"description": "Report generation failed",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -614,34 +560,31 @@ const docTemplate = `{
"name": "date",
"in": "query",
"required": true
},
{
"type": "string",
"description": "Monthly aggregation granularity: hourly or daily",
"name": "granularity",
"in": "query"
}
],
"responses": {
"200": {
"description": "Aggregation complete",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -673,28 +616,19 @@ const docTemplate = `{
"200": {
"description": "Snapshot started",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -714,17 +648,13 @@ const docTemplate = `{
"200": {
"description": "Migration results",
"schema": {
"type": "object",
"additionalProperties": true
"$ref": "#/definitions/models.SnapshotMigrationResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.SnapshotMigrationResponse"
}
}
}
@@ -744,17 +674,13 @@ const docTemplate = `{
"200": {
"description": "Regeneration summary",
"schema": {
"type": "object",
"additionalProperties": true
"$ref": "#/definitions/models.SnapshotRegenerateReportsResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -774,10 +700,7 @@ const docTemplate = `{
"200": {
"description": "OK",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.SnapshotRepairResponse"
}
}
}
@@ -797,10 +720,7 @@ const docTemplate = `{
"200": {
"description": "OK",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.SnapshotRepairSuiteResponse"
}
}
}
@@ -1214,6 +1134,17 @@ const docTemplate = `{
}
}
},
"models.ErrorResponse": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"models.ImportReceived": {
"type": "object",
"properties": {
@@ -1254,6 +1185,119 @@ const docTemplate = `{
"type": "string"
}
}
},
"models.SnapshotMigrationResponse": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"stats": {
"$ref": "#/definitions/models.SnapshotMigrationStats"
},
"status": {
"type": "string"
}
}
},
"models.SnapshotMigrationStats": {
"type": "object",
"properties": {
"DailyRegistered": {
"type": "integer"
},
"Errors": {
"type": "integer"
},
"HourlyRegistered": {
"type": "integer"
},
"HourlyRenamed": {
"type": "integer"
},
"MonthlyRegistered": {
"type": "integer"
}
}
},
"models.SnapshotRegenerateReportsResponse": {
"type": "object",
"properties": {
"errors": {
"type": "integer"
},
"regenerated": {
"type": "integer"
},
"reports_dir": {
"type": "string"
},
"skipped": {
"type": "integer"
},
"snapshotType": {
"type": "string"
},
"status": {
"type": "string"
},
"total": {
"type": "integer"
}
}
},
"models.SnapshotRepairResponse": {
"type": "object",
"properties": {
"failed": {
"type": "string"
},
"repaired": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"models.SnapshotRepairSuiteResponse": {
"type": "object",
"properties": {
"daily_failed": {
"type": "string"
},
"daily_repaired": {
"type": "string"
},
"monthly_failed": {
"type": "string"
},
"monthly_refined": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"models.StatusMessageResponse": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"models.StatusResponse": {
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
}
}
}`

View File

@@ -81,19 +81,13 @@
"200": {
"description": "Cleanup completed",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -130,19 +124,13 @@
"200": {
"description": "Ciphertext response",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -271,28 +259,19 @@
"200": {
"description": "Modify event processed",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"202": {
"description": "No relevant changes",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -327,28 +306,19 @@
"200": {
"description": "Move event processed",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -382,19 +352,13 @@
"200": {
"description": "Import processed",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -430,19 +394,13 @@
"200": {
"description": "Cleanup completed",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusMessageResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -494,10 +452,7 @@
"500": {
"description": "Report generation failed",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -532,19 +487,13 @@
"400": {
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -570,10 +519,7 @@
"500": {
"description": "Report generation failed",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -603,34 +549,31 @@
"name": "date",
"in": "query",
"required": true
},
{
"type": "string",
"description": "Monthly aggregation granularity: hourly or daily",
"name": "granularity",
"in": "query"
}
],
"responses": {
"200": {
"description": "Aggregation complete",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -662,28 +605,19 @@
"200": {
"description": "Snapshot started",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.StatusResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -703,17 +637,13 @@
"200": {
"description": "Migration results",
"schema": {
"type": "object",
"additionalProperties": true
"$ref": "#/definitions/models.SnapshotMigrationResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.SnapshotMigrationResponse"
}
}
}
@@ -733,17 +663,13 @@
"200": {
"description": "Regeneration summary",
"schema": {
"type": "object",
"additionalProperties": true
"$ref": "#/definitions/models.SnapshotRegenerateReportsResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
@@ -763,10 +689,7 @@
"200": {
"description": "OK",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.SnapshotRepairResponse"
}
}
}
@@ -786,10 +709,7 @@
"200": {
"description": "OK",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"$ref": "#/definitions/models.SnapshotRepairSuiteResponse"
}
}
}
@@ -1203,6 +1123,17 @@
}
}
},
"models.ErrorResponse": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"models.ImportReceived": {
"type": "object",
"properties": {
@@ -1243,6 +1174,119 @@
"type": "string"
}
}
},
"models.SnapshotMigrationResponse": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"stats": {
"$ref": "#/definitions/models.SnapshotMigrationStats"
},
"status": {
"type": "string"
}
}
},
"models.SnapshotMigrationStats": {
"type": "object",
"properties": {
"DailyRegistered": {
"type": "integer"
},
"Errors": {
"type": "integer"
},
"HourlyRegistered": {
"type": "integer"
},
"HourlyRenamed": {
"type": "integer"
},
"MonthlyRegistered": {
"type": "integer"
}
}
},
"models.SnapshotRegenerateReportsResponse": {
"type": "object",
"properties": {
"errors": {
"type": "integer"
},
"regenerated": {
"type": "integer"
},
"reports_dir": {
"type": "string"
},
"skipped": {
"type": "integer"
},
"snapshotType": {
"type": "string"
},
"status": {
"type": "string"
},
"total": {
"type": "integer"
}
}
},
"models.SnapshotRepairResponse": {
"type": "object",
"properties": {
"failed": {
"type": "string"
},
"repaired": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"models.SnapshotRepairSuiteResponse": {
"type": "object",
"properties": {
"daily_failed": {
"type": "string"
},
"daily_repaired": {
"type": "string"
},
"monthly_failed": {
"type": "string"
},
"monthly_refined": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"models.StatusMessageResponse": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"models.StatusResponse": {
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
}
}
}

View File

@@ -126,6 +126,13 @@ definitions:
modified:
type: string
type: object
models.ErrorResponse:
properties:
message:
type: string
status:
type: string
type: object
models.ImportReceived:
properties:
Cluster:
@@ -153,6 +160,79 @@ definitions:
VmId:
type: string
type: object
models.SnapshotMigrationResponse:
properties:
error:
type: string
stats:
$ref: '#/definitions/models.SnapshotMigrationStats'
status:
type: string
type: object
models.SnapshotMigrationStats:
properties:
DailyRegistered:
type: integer
Errors:
type: integer
HourlyRegistered:
type: integer
HourlyRenamed:
type: integer
MonthlyRegistered:
type: integer
type: object
models.SnapshotRegenerateReportsResponse:
properties:
errors:
type: integer
regenerated:
type: integer
reports_dir:
type: string
skipped:
type: integer
snapshotType:
type: string
status:
type: string
total:
type: integer
type: object
models.SnapshotRepairResponse:
properties:
failed:
type: string
repaired:
type: string
status:
type: string
type: object
models.SnapshotRepairSuiteResponse:
properties:
daily_failed:
type: string
daily_repaired:
type: string
monthly_failed:
type: string
monthly_refined:
type: string
status:
type: string
type: object
models.StatusMessageResponse:
properties:
message:
type: string
status:
type: string
type: object
models.StatusResponse:
properties:
status:
type: string
type: object
info:
contact: {}
paths:
@@ -209,15 +289,11 @@ paths:
"200":
description: Cleanup completed
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.StatusMessageResponse'
"400":
description: Invalid request
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
summary: Cleanup vCenter inventory (deprecated)
tags:
- maintenance
@@ -241,15 +317,11 @@ paths:
"200":
description: Ciphertext response
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.StatusMessageResponse'
"500":
description: Server error
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
summary: Encrypt data
tags:
- crypto
@@ -337,21 +409,15 @@ paths:
"200":
description: Modify event processed
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.StatusMessageResponse'
"202":
description: No relevant changes
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.StatusMessageResponse'
"500":
description: Server error
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
summary: Record VM modify event (deprecated)
tags:
- events
@@ -375,21 +441,15 @@ paths:
"200":
description: Move event processed
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.StatusMessageResponse'
"400":
description: Invalid request
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
"500":
description: Server error
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
summary: Record VM move event (deprecated)
tags:
- events
@@ -411,15 +471,11 @@ paths:
"200":
description: Import processed
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.StatusMessageResponse'
"500":
description: Server error
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
summary: Import VMs
tags:
- inventory
@@ -443,15 +499,11 @@ paths:
"200":
description: Cleanup completed
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.StatusMessageResponse'
"400":
description: Invalid request
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
summary: Cleanup VM inventory entry
tags:
- inventory
@@ -485,9 +537,7 @@ paths:
"500":
description: Report generation failed
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
summary: Download inventory report
tags:
- reports
@@ -510,15 +560,11 @@ paths:
"400":
description: Invalid request
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
"500":
description: Server error
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
summary: Download snapshot report
tags:
- snapshots
@@ -535,9 +581,7 @@ paths:
"500":
description: Report generation failed
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
summary: Download updates report
tags:
- reports
@@ -556,27 +600,25 @@ paths:
name: date
required: true
type: string
- description: 'Monthly aggregation granularity: hourly or daily'
in: query
name: granularity
type: string
produces:
- application/json
responses:
"200":
description: Aggregation complete
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.StatusResponse'
"400":
description: Invalid request
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
"500":
description: Server error
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
summary: Force snapshot aggregation
tags:
- snapshots
@@ -598,21 +640,15 @@ paths:
"200":
description: Snapshot started
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.StatusResponse'
"400":
description: Invalid request
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
"500":
description: Server error
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
summary: Trigger hourly snapshot (manual)
tags:
- snapshots
@@ -626,14 +662,11 @@ paths:
"200":
description: Migration results
schema:
additionalProperties: true
type: object
$ref: '#/definitions/models.SnapshotMigrationResponse'
"500":
description: Server error
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.SnapshotMigrationResponse'
summary: Migrate snapshot registry
tags:
- snapshots
@@ -647,14 +680,11 @@ paths:
"200":
description: Regeneration summary
schema:
additionalProperties: true
type: object
$ref: '#/definitions/models.SnapshotRegenerateReportsResponse'
"500":
description: Server error
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.ErrorResponse'
summary: Regenerate hourly snapshot reports
tags:
- snapshots
@@ -668,9 +698,7 @@ paths:
"200":
description: OK
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.SnapshotRepairResponse'
summary: Repair daily summaries
tags:
- snapshots
@@ -684,9 +712,7 @@ paths:
"200":
description: OK
schema:
additionalProperties:
type: string
type: object
$ref: '#/definitions/models.SnapshotRepairSuiteResponse'
summary: Run full snapshot repair suite
tags:
- snapshots