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

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

Browse Source
This commit is contained in:
Nathan Coad
2026-01-22 20:30:02 +11:00
parent 68ee2838e4
commit c8f04efd51
7 changed files with 500 additions and 325 deletions
Download Patch File Download Diff File Expand all files Collapse all files

202
server/router/docs/swagger.yaml
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