@itentialopensource/adapter-openstack_cinder
Version:
This adapter integrates with system described as: Openstack Block Storage (Cinder) Service
1,839 lines (1,838 loc) • 290 kB
JSON
{
"id": "@itentialopensource/adapter-openstack_cinder",
"type": "Adapter",
"export": "OpenstackCinder",
"title": "Openstack_cinder",
"src": "adapter.js",
"roles": [
"admin"
],
"methods": [
{
"name": "iapUpdateAdapterConfiguration",
"summary": "Updates the adapter configuration",
"description": "Updates the adapter configuration file with the provided changes",
"input": [
{
"name": "configFile",
"type": "string",
"info": "The name of the file to change",
"required": true,
"schema": {
"title": "configFile",
"type": "string"
}
},
{
"name": "changes",
"type": "object",
"info": "JSON object containing the configuration changes",
"required": true,
"schema": {
"title": "changes",
"type": "object"
}
},
{
"name": "entity",
"type": "string",
"info": "The entity in which the changes are being made",
"required": false,
"schema": {
"title": "entity",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "The type of file to change - action, schema, or mock",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "action",
"type": "string",
"info": "The action to be changed",
"required": false,
"schema": {
"title": "action",
"type": "string"
}
},
{
"name": "replace",
"type": "boolean",
"info": "True to replace entire mock data, false to merge/append",
"required": false,
"schema": {
"title": "replace",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUpdateAdapterConfiguration"
},
"task": true
},
{
"name": "iapSuspendAdapter",
"summary": "Suspends the adapter",
"description": "Suspends the adapter",
"input": [
{
"name": "mode",
"type": "enum",
"enumerals": [
"pause",
"error"
],
"info": "How incoming requests are handled. Defaults to 'pause'",
"description": "How incoming requests are handled. Defaults to 'pause'",
"schema": {
"title": "mode",
"type": "string"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapSuspendAdapter"
},
"task": true
},
{
"name": "iapUnsuspendAdapter",
"summary": "Unsuspends the adapter",
"description": "Unsuspends the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUnsuspendAdapter"
},
"task": true
},
{
"name": "iapGetAdapterQueue",
"summary": "Return the requests that are waiting in the queue if throttling is enabled",
"description": "Return the requests that are waiting in the queue if throttling is enabled",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter queue",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetAdapterQueue"
},
"task": true
},
{
"name": "iapFindAdapterPath",
"summary": "Provides the ability to see if a particular API path is supported by the adapter",
"description": "Provides the ability to see if a particular API path is supported by the adapter",
"input": [
{
"name": "apiPath",
"type": "string",
"info": "The API Path you want to check - make sure to not include base path and version",
"description": "The API Path you want to check - make sure to not include base path and version",
"schema": {
"title": "apiPath",
"type": "string"
},
"required": true
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapFindAdapterPath"
},
"task": true
},
{
"name": "iapTroubleshootAdapter",
"summary": "Runs troubleshoot script for adapter",
"description": "Runs troubleshoot script for adapter",
"input": [
{
"name": "props",
"type": "object",
"info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
"required": true,
"schema": {
"title": "props",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapTroubleshootAdapter"
},
"task": true
},
{
"name": "iapRunAdapterHealthcheck",
"summary": "Runs healthcheck script for adapter",
"description": "Runs healthcheck script for adapter",
"input": [],
"output": {
"name": "result",
"type": "boolean",
"description": "Whether healthcheck passed or failed",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterHealthcheck"
},
"task": true
},
{
"name": "iapRunAdapterConnectivity",
"summary": "Runs connectivity check script for adapter",
"description": "Runs connectivity check script for adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterConnectivity"
},
"task": true
},
{
"name": "iapRunAdapterBasicGet",
"summary": "Runs basicGet script for adapter",
"description": "Runs basicGet script for adapter",
"input": [
{
"name": "maxCalls",
"required": false,
"type": "number",
"info": "How many GET endpoints to test (defaults to 5)",
"schema": {
"title": "maxCalls",
"type": "number",
"default": 5
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterBasicGet"
},
"task": true
},
{
"name": "iapMoveAdapterEntitiesToDB",
"summary": "Moves entities from an adapter into the Itential Platform database",
"description": "Moves entities from an adapter into the Itential Platform database",
"input": [],
"output": {
"name": "res",
"type": "object",
"description": "A JSON Object containing status, code and the response from the mongo transaction",
"schema": {
"title": "res",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapMoveAdapterEntitiesToDB"
},
"task": true
},
{
"name": "iapDeactivateTasks",
"summary": "Deactivate the inputted tasks",
"description": "Deactivate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to deactivate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapDeactivateTasks"
},
"task": true
},
{
"name": "iapActivateTasks",
"summary": "Activate the inputted tasks",
"description": "activate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to activate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapActivateTasks"
},
"task": true
},
{
"name": "iapPopulateEntityCache",
"summary": "Populate the cache for the given entities",
"description": "Populate the cache for the given entities",
"input": [
{
"name": "entityTypes",
"type": "array",
"info": "the entity type(s) to populate",
"required": true,
"schema": {
"title": "entityTypes",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapPopulateEntityCache"
},
"task": true
},
{
"name": "iapRetrieveEntitiesCache",
"summary": "Retrieves data from cache for specified entity type",
"description": "Retrieves data from cache for specified entity type",
"input": [
{
"name": "entityType",
"type": "string",
"info": "entity of which to retrieve",
"required": true,
"schema": {
"title": "entityType",
"type": "string"
}
},
{
"name": "options",
"type": "object",
"info": "settings of which data to return and how to return it",
"required": false,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRetrieveEntitiesCache"
},
"task": true
},
{
"name": "getDevice",
"summary": "Get the Appliance",
"description": "Get the Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevice"
},
"task": false
},
{
"name": "getDevicesFiltered",
"summary": "Get Appliances that match the filter",
"description": "Get Appliances that match the filter",
"input": [
{
"name": "options",
"type": "object",
"info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
"required": true,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "array",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "array"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevicesFiltered"
},
"task": false
},
{
"name": "isAlive",
"summary": "Checks the status for the provided Appliance",
"description": "Checks the status for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "boolean",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/isAlive"
},
"task": false
},
{
"name": "getConfig",
"summary": "Gets a config for the provided Appliance",
"description": "Gets a config for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "format",
"type": "string",
"info": "The format to be returned - this is ignored as we always return json",
"required": false,
"schema": {
"title": "format",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getConfig"
},
"task": false
},
{
"name": "iapGetDeviceCount",
"summary": "Gets a device count from the system",
"description": "Gets a device count from the system",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetDeviceCount"
},
"task": false
},
{
"name": "iapExpandedGenericAdapterRequest",
"summary": "Makes the requested generic call with additional options",
"description": "Makes the requested generic call with additional options via metadata",
"input": [
{
"name": "metadata",
"type": "object",
"info": "metadata for the call (optional)",
"description": "metadata for the call - allows for many enhancements (optional)",
"schema": {
"title": "metadata",
"type": "object"
},
"required": false
},
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": false
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": false
},
{
"name": "pathVars",
"type": "object",
"info": "the parameters to be put within the url path (optional)",
"description": "the parameters to be put within the url path (optional)",
"schema": {
"title": "pathVars",
"type": "object"
},
"required": false
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapExpandedGenericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequest",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequestNoBasePath",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequestNoBasePath"
},
"task": true
},
{
"name": "iapRunAdapterLint",
"summary": "Run the adapter lint script to return the results",
"description": "Run the adapter lint script to return the results",
"input": [],
"output": {
"name": "result",
"type": "string",
"description": "A string containing the run results",
"schema": {
"title": "result",
"type": "string"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterLint"
},
"task": true
},
{
"name": "iapRunAdapterTests",
"summary": "Run the adapter test scripts (baseunit and unit) to return the results",
"description": "Run the adapter test scripts (baseunit and unit) to return the results",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterTests"
},
"task": true
},
{
"name": "iapGetAdapterInventory",
"summary": "Provide inventory information abbout the adapter",
"description": "Provide inventory information abbout the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapGetAdapterInventory"
},
"task": true
},
{
"name": "listAllApiVersions",
"summary": "List All Api Versions",
"description": "List All Api Versions",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/listAllApiVersions"
},
"task": true
},
{
"name": "showAPIV3Details",
"summary": "Show API v3 details",
"description": "Show API v3 details",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/showAPIV3Details"
},
"task": true
},
{
"name": "listKnownAPIExtensions",
"summary": "List Known API extensions",
"description": "List Known API extensions",
"input": [
{
"name": "projectId",
"type": "string",
"info": "The UUID of the project in a multi-tenancy cloud.: string",
"required": true,
"schema": {
"title": "projectId",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/listKnownAPIExtensions"
},
"task": true
},
{
"name": "updateAVolumeType",
"summary": "Update a volume type",
"description": "Update a volume type",
"input": [
{
"name": "projectId",
"type": "string",
"info": "The UUID of the project in a multi-tenancy cloud.: string",
"required": true,
"schema": {
"title": "projectId",
"type": "string"
}
},
{
"name": "volumeTypeId",
"type": "string",
"info": "The UUID for an existing volume type.: string",
"required": true,
"schema": {
"title": "volumeTypeId",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"volume_type\": {\"name\": \"string\", \"description\": \"string\", \"is_public\": \"boolean\"}}",
"required": false,
"schema": {
"type": "object",
"properties": {
"volume_type": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_public": {
"type": "boolean"
}
}
}
},
"definitions": {}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateAVolumeType"
},
"task": true
},
{
"name": "showVolumeTypeDetail",
"summary": "Show volume type detail",
"description": "Show volume type detail",
"input": [
{
"name": "projectId",
"type": "string",
"info": "The UUID of the project in a multi-tenancy cloud.: string",
"required": true,
"schema": {
"title": "projectId",
"type": "string"
}
},
{
"name": "volumeTypeId",
"type": "string",
"info": "The UUID for an existing volume type.: string",
"required": true,
"schema": {
"title": "volumeTypeId",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/showVolumeTypeDetail"
},
"task": true
},
{
"name": "deleteAVolumeType",
"summary": "Delete a volume type",
"description": "Delete a volume type",
"input": [
{
"name": "projectId",
"type": "string",
"info": "The UUID of the project in a multi-tenancy cloud.: string",
"required": true,
"schema": {
"title": "projectId",
"type": "string"
}
},
{
"name": "volumeTypeId",
"type": "string",
"info": "The UUID for an existing volume type.: string",
"required": true,
"schema": {
"title": "volumeTypeId",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteAVolumeType"
},
"task": true
},
{
"name": "createOrUpdateExtraSpecsForVolumeType",
"summary": "Create or update extra specs for volume type",
"description": "Create or update extra specs for volume type",
"input": [
{
"name": "projectId",
"type": "string",
"info": "The UUID of the project in a multi-tenancy cloud.: string",
"required": true,
"schema": {
"title": "projectId",
"type": "string"
}
},
{
"name": "volumeTypeId",
"type": "string",
"info": "The UUID for an existing volume type.: string",
"required": true,
"schema": {
"title": "volumeTypeId",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"extra_specs\": {\"key1\": \"string\", \"key2\": \"string\"}}",
"required": false,
"schema": {
"type": "object",
"properties": {
"extra_specs": {
"type": "object",
"properties": {
"key1": {
"type": "string"
},
"key2": {
"type": "string"
}
}
}
},
"definitions": {}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/createOrUpdateExtraSpecsForVolumeType"
},
"task": true
},
{
"name": "showAllExtraSpecificationsForVolumeType",
"summary": "Show all extra specifications for volume type",
"description": "Show all extra specifications for volume type",
"input": [
{
"name": "projectId",
"type": "string",
"info": "The UUID of the project in a multi-tenancy cloud.: string",
"required": true,
"schema": {
"title": "projectId",
"type": "string"
}
},
{
"name": "volumeTypeId",
"type": "string",
"info": "The UUID for an existing volume type.: string",
"required": true,
"schema": {
"title": "volumeTypeId",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/showAllExtraSpecificationsForVolumeType"
},
"task": true
},
{
"name": "showExtraSpecificationForVolumeType",
"summary": "Show extra specification for volume type",
"description": "Show extra specification for volume type",
"input": [
{
"name": "projectId",
"type": "string",
"info": "The UUID of the project in a multi-tenancy cloud.: string",
"required": true,
"schema": {
"title": "projectId",
"type": "string"
}
},
{
"name": "volumeTypeId",
"type": "string",
"info": "The UUID for an existing volume type.: string",
"required": true,
"schema": {
"title": "volumeTypeId",
"type": "string"
}
},
{
"name": "key",
"type": "string",
"info": "The key name of the extra spec for a volume type.: string",
"required": true,
"schema": {
"title": "key",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/showExtraSpecificationForVolumeType"
},
"task": true
},
{
"name": "updateExtraSpecificationForVolumeType",
"summary": "Update extra specification for volume type",
"description": "Update extra specification for volume type",
"input": [
{
"name": "projectId",
"type": "string",
"info": "The UUID of the project in a multi-tenancy cloud.: string",
"required": true,
"schema": {
"title": "projectId",
"type": "string"
}
},
{
"name": "volumeTypeId",
"type": "string",
"info": "The UUID for an existing volume type.: string",
"required": true,
"schema": {
"title": "volumeTypeId",
"type": "string"
}
},
{
"name": "key",
"type": "string",
"info": "The key name of the extra spec for a volume type.: string",
"required": true,
"schema": {
"title": "key",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"key1\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"properties": {
"key1": {
"type": "string"
}
},
"definitions": {}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateExtraSpecificationForVolumeType"
},
"task": true
},
{
"name": "deleteExtraSpecificationForVolumeType",
"summary": "Delete extra specification for volume type",
"description": "Delete extra specification for volume type",
"input": [
{
"name": "projectId",
"type": "string",
"info": "The UUID of the project in a multi-tenancy cloud.: string",
"required": true,
"schema": {
"title": "projectId",
"type": "string"
}
},
{
"name": "volumeTypeId",
"type": "string",
"info": "The UUID for an existing volume type.: string",
"required": true,
"schema": {
"title": "volumeTypeId",
"type": "string"
}
},
{
"name": "key",
"type": "string",
"info": "The key name of the extra spec for a volume type.: string",
"required": true,
"schema": {
"title": "key",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteExtraSpecificationForVolumeType"
},
"task": true
},
{
"name": "showDefaultVolumeType",
"summary": "Show default volume type",
"description": "Show default volume type",
"input": [
{
"name": "projectId",
"type": "string",
"info": "The UUID of the project in a multi-tenancy cloud.: string",
"required": true,
"schema": {
"title": "projectId",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/showDefaultVolumeType"
},
"task": true
},
{
"name": "listAllVolumeTypes",
"summary": "List all volume types",
"description": "List all volume types",
"input": [
{
"name": "isPublic",
"type": "boolean",
"info": "Filter the volume type by public visibility.\nSee valid boolean values.: boolean",
"required": false,
"schema": {
"title": "isPublic",
"type": "boolean"
}
},
{
"name": "sort",
"type": "string",
"info": "Comma-separated list of sort keys and optional\nsort directions in the form of [: ]. A valid\ndirection is asc (ascending) or desc (descending).: string",
"required": false,
"schema": {
"title": "sort",
"type": "string"
}
},
{
"name": "limit",
"type": "number",
"info": "Requests a page size of items. Returns a number\nof items up to a limit value. Use the limit parameter to make\nan initial limited request and use the ID of the last-seen i...(description truncated): 123",
"required": false,
"schema": {
"title": "limit",
"type": "number"
}
},
{
"name": "offset",
"type": "number",
"info": "Used in conjunction with limit to return a slice of items. offset\nis where to start in the list.: 123",
"required": false,
"schema": {
"title": "offset",
"type": "number"
}
},
{
"name": "marker",
"type": "string",
"info": "The ID of the last-seen item. Use the limit\nparameter to make an initial limited request and use the ID of the\nlast-seen item from the response as the marker parameter va...(description truncated): string",
"required": false,
"schema": {
"title": "marker",
"type": "string"
}
},
{
"name": "projectId",
"type": "string",
"info": "The UUID of the project in a multi-tenancy cloud.: string",
"required": true,
"schema": {
"title": "projectId",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/listAllVolumeTypes"
},
"task": true
},
{
"name": "createAVolumeType",
"summary": "Create a volume type",
"description": "Create a volume type",
"input": [
{
"name": "projectId",
"type": "string",
"info": "The UUID of the project in a multi-tenancy cloud.: string",
"required": true,
"schema": {
"title": "projectId",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"volume_type\": {\"name\": \"string\", \"description\": \"string\", \"os-volume-type-access:is_public\": \"boolean\", \"extra_specs\": {\"capabilities\": \"string\"}}}",
"required": false,
"schema": {
"type": "object",
"properties": {
"volume_type": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"os-volume-type-access:is_public": {
"type": "boolean"
},
"extra_specs": {
"type": "object",
"properties": {
"capabilities": {
"type": "string"
}
}
}
}
}
},
"definitions": {}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/createAVolumeType"
},
"task": true
},
{
"name": "showAnEncryptionType",
"summary": "Show an encryption type",
"description": "Show an encryption type",
"input": [
{
"name": "projectId",
"type": "string",
"info": "The UUID of the project in a multi-tenancy cloud.: string",
"required": true,
"schema": {
"title": "projectId",
"type": "string"
}
},
{
"name": "volumeTypeId",
"type": "string",
"info": "The UUID for an existing volume type.: string",
"required": true,
"schema": {
"title": "volumeTypeId",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/showAnEncryptionType"
},
"task": true
},
{
"name": "createAnEncryptionType",
"summary": "Create an encryption type",
"description": "Create an encryption type",
"input": [
{
"name": "projectId",
"type": "string",
"info": "The UUID of the project in a multi-tenancy cloud.: string",
"required": true,
"schema": {
"title": "projectId",
"type": "string"
}
},
{
"name": "volumeTypeId",
"type": "string",
"info": "The UUID for an existing volume type.: string",
"required": true,
"schema": {
"title": "volumeTypeId",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"encryption\": {\"key_size\": 123, \"provider\": \"string\", \"control_location\": \"string\", \"cipher\": \"string\"}}",
"required": false,
"schema": {
"type": "object",
"properties": {
"encryption": {
"type": "object",
"properties": {
"key_size": {
"type": "integer"
},
"provider": {
"type": "string"
},
"control_location": {
"type": "string"
},
"cipher": {
"type": "string"
}
}
}
},
"definitions": {}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/createAnEncryptionType"
},
"task": true
},
{
"name": "showEncryptionSpecsItem",
"summary": "Show encryption specs item",
"description": "Show encryption specs item",
"input": [
{
"name": "projectId",
"type": "string",
"info": "The UUID of the project in a multi-tenancy cloud.: string",
"required": true,
"schema": {
"title": "projectId",
"type": "string"
}
},
{