484 lines
12 KiB
YAML
484 lines
12 KiB
YAML
definitions:
|
|
models.CloudEventReceived:
|
|
type: object
|
|
models.CloudEventResourcePool:
|
|
properties:
|
|
Name:
|
|
type: string
|
|
ResourcePool:
|
|
properties:
|
|
Type:
|
|
type: string
|
|
Value:
|
|
type: string
|
|
type: object
|
|
type: object
|
|
models.CloudEventVm:
|
|
properties:
|
|
Name:
|
|
type: string
|
|
Vm:
|
|
properties:
|
|
Type:
|
|
type: string
|
|
Value:
|
|
type: string
|
|
type: object
|
|
type: object
|
|
models.ImportReceived:
|
|
properties:
|
|
Cluster:
|
|
type: string
|
|
CreationTime:
|
|
type: integer
|
|
Datacenter:
|
|
type: string
|
|
Folder:
|
|
type: string
|
|
InitialRam:
|
|
type: integer
|
|
InitialVcpus:
|
|
type: integer
|
|
Name:
|
|
type: string
|
|
PowerState:
|
|
type: integer
|
|
ProvisionedDisk:
|
|
type: number
|
|
ResourcePool:
|
|
type: string
|
|
Vcenter:
|
|
type: string
|
|
VmId:
|
|
type: string
|
|
type: object
|
|
info:
|
|
contact: {}
|
|
paths:
|
|
/:
|
|
get:
|
|
description: Renders the main UI page.
|
|
produces:
|
|
- text/html
|
|
responses:
|
|
"200":
|
|
description: HTML page
|
|
schema:
|
|
type: string
|
|
"500":
|
|
description: Render failed
|
|
schema:
|
|
type: string
|
|
summary: Home page
|
|
tags:
|
|
- ui
|
|
/api/cleanup/updates:
|
|
delete:
|
|
description: Removes update records that are no longer associated with a VM.
|
|
produces:
|
|
- text/plain
|
|
responses:
|
|
"200":
|
|
description: Cleanup completed
|
|
schema:
|
|
type: string
|
|
"500":
|
|
description: Server error
|
|
schema:
|
|
type: string
|
|
summary: Cleanup updates
|
|
tags:
|
|
- maintenance
|
|
/api/cleanup/vcenter:
|
|
delete:
|
|
description: Removes all inventory entries associated with a vCenter URL.
|
|
parameters:
|
|
- description: vCenter URL
|
|
in: query
|
|
name: vc_url
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Cleanup completed
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"400":
|
|
description: Invalid request
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Cleanup vCenter inventory
|
|
tags:
|
|
- maintenance
|
|
/api/encrypt:
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Encrypts a plaintext value and returns the ciphertext.
|
|
parameters:
|
|
- description: Plaintext payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Ciphertext response
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"500":
|
|
description: Server error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Encrypt data
|
|
tags:
|
|
- crypto
|
|
/api/event/vm/create:
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Parses a VM create CloudEvent and stores the event data.
|
|
parameters:
|
|
- description: CloudEvent payload
|
|
in: body
|
|
name: event
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/models.CloudEventReceived'
|
|
produces:
|
|
- text/plain
|
|
responses:
|
|
"200":
|
|
description: Create event processed
|
|
schema:
|
|
type: string
|
|
"400":
|
|
description: Invalid request
|
|
schema:
|
|
type: string
|
|
"500":
|
|
description: Server error
|
|
schema:
|
|
type: string
|
|
summary: Record VM create event
|
|
tags:
|
|
- events
|
|
/api/event/vm/delete:
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Parses a VM delete CloudEvent and marks the VM as deleted in inventory.
|
|
parameters:
|
|
- description: CloudEvent payload
|
|
in: body
|
|
name: event
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/models.CloudEventReceived'
|
|
produces:
|
|
- text/plain
|
|
responses:
|
|
"200":
|
|
description: Delete event processed
|
|
schema:
|
|
type: string
|
|
"400":
|
|
description: Invalid request
|
|
schema:
|
|
type: string
|
|
"500":
|
|
description: Server error
|
|
schema:
|
|
type: string
|
|
summary: Record VM delete event
|
|
tags:
|
|
- events
|
|
/api/event/vm/modify:
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Parses a VM modify CloudEvent and creates an update record when
|
|
relevant changes are detected.
|
|
parameters:
|
|
- description: CloudEvent payload
|
|
in: body
|
|
name: event
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/models.CloudEventReceived'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Modify event processed
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"202":
|
|
description: No relevant changes
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"500":
|
|
description: Server error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Record VM modify event
|
|
tags:
|
|
- events
|
|
/api/event/vm/move:
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Parses a VM move CloudEvent and creates an update record.
|
|
parameters:
|
|
- description: CloudEvent payload
|
|
in: body
|
|
name: event
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/models.CloudEventReceived'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Move event processed
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"400":
|
|
description: Invalid request
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"500":
|
|
description: Server error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Record VM move event
|
|
tags:
|
|
- events
|
|
/api/import/vm:
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Imports existing VM inventory data in bulk.
|
|
parameters:
|
|
- description: Bulk import payload
|
|
in: body
|
|
name: import
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/models.ImportReceived'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Import processed
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"500":
|
|
description: Server error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Import VMs
|
|
tags:
|
|
- inventory
|
|
/api/inventory/vm/delete:
|
|
delete:
|
|
description: Removes a VM inventory entry by VM ID and datacenter name.
|
|
parameters:
|
|
- description: VM ID
|
|
in: query
|
|
name: vm_id
|
|
required: true
|
|
type: string
|
|
- description: Datacenter name
|
|
in: query
|
|
name: datacenter_name
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Cleanup completed
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"400":
|
|
description: Invalid request
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Cleanup VM inventory entry
|
|
tags:
|
|
- inventory
|
|
/api/inventory/vm/update:
|
|
post:
|
|
description: Queries vCenter and updates inventory records with missing details.
|
|
produces:
|
|
- text/plain
|
|
responses:
|
|
"200":
|
|
description: Update completed
|
|
schema:
|
|
type: string
|
|
"500":
|
|
description: Server error
|
|
schema:
|
|
type: string
|
|
summary: Refresh VM details
|
|
tags:
|
|
- inventory
|
|
/api/report/inventory:
|
|
get:
|
|
description: Generates an inventory XLSX report and returns it as a file download.
|
|
produces:
|
|
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
|
|
responses:
|
|
"200":
|
|
description: Inventory XLSX report
|
|
schema:
|
|
type: file
|
|
"500":
|
|
description: Report generation failed
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Download inventory report
|
|
tags:
|
|
- reports
|
|
/api/report/snapshot:
|
|
get:
|
|
description: Downloads a snapshot table as an XLSX file.
|
|
parameters:
|
|
- description: Snapshot table name
|
|
in: query
|
|
name: table
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
|
|
responses:
|
|
"200":
|
|
description: Snapshot XLSX report
|
|
schema:
|
|
type: file
|
|
"400":
|
|
description: Invalid request
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"500":
|
|
description: Server error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Download snapshot report
|
|
tags:
|
|
- snapshots
|
|
/api/report/updates:
|
|
get:
|
|
description: Generates an updates XLSX report and returns it as a file download.
|
|
produces:
|
|
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
|
|
responses:
|
|
"200":
|
|
description: Updates XLSX report
|
|
schema:
|
|
type: file
|
|
"500":
|
|
description: Report generation failed
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Download updates report
|
|
tags:
|
|
- reports
|
|
/snapshots/daily:
|
|
get:
|
|
description: Lists daily summary snapshot tables.
|
|
produces:
|
|
- text/html
|
|
responses:
|
|
"200":
|
|
description: HTML page
|
|
schema:
|
|
type: string
|
|
"500":
|
|
description: Server error
|
|
schema:
|
|
type: string
|
|
summary: List daily snapshots
|
|
tags:
|
|
- snapshots
|
|
/snapshots/hourly:
|
|
get:
|
|
description: Lists hourly inventory snapshot tables.
|
|
produces:
|
|
- text/html
|
|
responses:
|
|
"200":
|
|
description: HTML page
|
|
schema:
|
|
type: string
|
|
"500":
|
|
description: Server error
|
|
schema:
|
|
type: string
|
|
summary: List hourly snapshots
|
|
tags:
|
|
- snapshots
|
|
/snapshots/monthly:
|
|
get:
|
|
description: Lists monthly summary snapshot tables.
|
|
produces:
|
|
- text/html
|
|
responses:
|
|
"200":
|
|
description: HTML page
|
|
schema:
|
|
type: string
|
|
"500":
|
|
description: Server error
|
|
schema:
|
|
type: string
|
|
summary: List monthly snapshots
|
|
tags:
|
|
- snapshots
|
|
swagger: "2.0"
|