VDI Plugin Server (8.0.0)

Download OpenAPI specification:Download

License: Apache 2.0

Import

Import Processing

Perform dataset validation and any pre-installation transformation that needs to be done.

The output of this endpoint is a zip containing the processing result files that are ready to be imported into the VDI Dataset Store (MinIO at the time of this writing)

The structure of the returned zip is as follows:

result.zip:
- warnings.json     # Import warnings
- vdi-manifest.json # File manifest
- data.zip          # Install-ready data
Request Body schema: multipart/form-data
required
object (ImportRequestDetails)
payload
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Install

Install Metadata

Request Body schema: application/json
vdiID
required
string (vdi-dataset-id) = 11 characters ^[0-9A-Za-z]{11}$
projectID
required
string (project-id) non-empty
required
object (vdi-dataset-meta)

Responses

Request samples

Content type
application/json
{
  • "vdiID": "stringstrin",
  • "projectID": "AmoebaDB",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Install Data

Request Body schema: multipart/form-data
required
object
required
object (vdi-dataset-meta)
required
object (vdi-dataset-manifest)
payload
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "warnings": [ ]
}

Uninstall

Uninstall

Request Body schema: application/json
vdiID
required
string (vdi-dataset-id) = 11 characters ^[0-9A-Za-z]{11}$
projectID
required
string (project-id) non-empty

Responses

Request samples

Content type
application/json
{
  • "vdiID": "stringstrin",
  • "projectID": "AmoebaDB"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Management

Prometheus Metrics

Responses