@itentialopensource/adapter-openstack_glance
Version:
This adapter integrates with system described as: Openstack Image (Glance) Service
1,841 lines • 67.7 kB
JSON
{
"id": "@itentialopensource/adapter-openstack_glance",
"type": "Adapter",
"export": "OpenstackGlance",
"title": "Openstack_glance",
"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": "createImage",
"summary": "Create image",
"description": "Create image",
"input": [
{
"name": "body",
"type": "object",
"info": ": {\"container_format\": \"string\", \"disk_format\": \"string\", \"name\": \"string\", \"id\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"properties": {
"container_format": {
"type": "string"
},
"disk_format": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"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": "/createImage"
},
"task": true
},
{
"name": "listImages",
"summary": "List images",
"description": "List images",
"input": [
{
"name": "limit",
"type": "number",
"info": "Requests a page size of items. Returns a number of items up to a limit\nvalue. Use the limit parameter to make an initial limited request and\nuse the ID of the last-seen i...(description truncated): 123",
"required": false,
"schema": {
"title": "limit",
"type": "number"
}
},
{
"name": "marker",
"type": "string",
"info": "The ID of the last-seen item. Use the limit parameter to make an\ninitial limited request and use the ID of the last-seen item from the\nresponse as the marker parameter va...(description truncated): string",
"required": false,
"schema": {
"title": "marker",
"type": "string"
}
},
{
"name": "name",
"type": "string",
"info": "Filters the response by a name, as a string. A valid value is the name of\nan image.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "owner",
"type": "string",
"info": "Filters the response by a project (also called a “tenant”) ID. Shows only\nimages that are shared with you by the specified owner.: string",
"required": false,
"schema": {
"title": "owner",
"type": "string"
}
},
{
"name": "protectedParam",
"type": "boolean",
"info": "Filters the response by the ‘protected’ image property. A valid value is\none of ‘true’, ‘false’ (must be all lowercase). Any other value will\nresult in a 400 response.: boolean",
"required": false,
"schema": {
"title": "protectedParam",
"type": "boolean"
}
},
{
"name": "status",
"type": "number",
"info": "Filters the response by an image status.: 123",
"required": false,
"schema": {
"title": "status",
"type": "number"
}
},
{
"name": "tag",
"type": "string",
"info": "Filters the response by the specified tag value. May be repeated, but keep\nin mind that you’re making a conjunctive query, so only images containing\nall the tags specifi...(description truncated): string",
"required": false,
"schema": {
"title": "tag",
"type": "string"
}
},
{
"name": "visibility",
"type": "string",
"info": "Filters the response by an image visibility value. A valid value is\npublic, private, community, shared, or all. (Note\nthat if you filter on shared, the images included ...(description truncated): string",
"required": false,
"schema": {
"title": "visibility",
"type": "string"
}
},
{
"name": "osHidden",
"type": "boolean",
"info": "When true, filters the response to display only “hidden” images. By\ndefault, “hidden” images are not included in the image-list response.\n(Since Image API v2.7): boolean",
"required": false,
"schema": {
"title": "osHidden",
"type": "boolean"
}
},
{
"name": "memberStatus",
"type": "string",
"info": "Filters the response by a member status. A valid value is accepted,\npending, rejected, or all. Default is accepted.: string",
"required": false,
"schema": {
"title": "memberStatus",
"type": "string"
}
},
{
"name": "sizeMax",
"type": "string",
"info": "Filters the response by a maximum image size, in\nbytes.: string",
"required": false,
"schema": {
"title": "sizeMax",
"type": "string"
}
},
{
"name": "sizeMin",
"type": "string",
"info": "Filters the response by a minimum image size, in\nbytes.: string",
"required": false,
"schema": {
"title": "sizeMin",
"type": "string"
}
},
{
"name": "createdAt",
"type": "string",
"info": "Specify a comparison filter based on the date and time when the resource\nwas created. (See Time Comparison Filters).: string",
"required": false,
"schema": {
"title": "createdAt",
"type": "string"
}
},
{
"name": "updatedAt",
"type": "string",
"info": "Specify a comparison filter based on the date and time when the resource\nwas most recently modified. (See Time Comparison Filters).: string",
"required": false,
"schema": {
"title": "updatedAt",
"type": "string"
}
},
{
"name": "sortDir",
"type": "string",
"info": "Sorts the response by a set of one or more sort\ndirection and attribute (sort_key) combinations. A valid value\nfor the sort direction is asc (ascending) or desc\n(descendi...(description truncated): string",
"required": false,
"schema": {
"title": "sortDir",
"type": "string"
}
},
{
"name": "sortKey",
"type": "string",
"info": "Sorts the response by an attribute, such as\nname, id, or updated_at. Default is created_at.\nThe API uses the natural sorting direction of the sort_key\nimage attribute.: string",
"required": false,
"schema": {
"title": "sortKey",
"type": "string"
}
},
{
"name": "sort",
"type": "string",
"info": "Sorts the response by one or more attribute and sort direction\ncombinations. You can also set multiple sort keys and directions.\nDefault direction is desc.: string",
"required": false,
"schema": {
"title": "sort",
"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": "/listImages"
},
"task": true
},
{
"name": "showImage",
"summary": "Show image",
"description": "Show image",
"input": [
{
"name": "imageId",
"type": "string",
"info": "The UUID of the image.: string",
"required": true,
"schema": {
"title": "imageId",
"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": "/showImage"
},
"task": true
},
{
"name": "updateImage",
"summary": "Update image",
"description": "Update image",
"input": [
{
"name": "imageId",
"type": "string",
"info": "The UUID of the image.: string",
"required": true,
"schema": {
"title": "imageId",
"type": "string"
}
},
{
"name": "body",
"type": "array",
"info": ": array",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
]
},
"path": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"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": "/updateImage"
},
"task": true
},
{
"name": "deleteImage",
"summary": "Delete image",
"description": "Delete image",
"input": [
{
"name": "imageId",
"type": "string",
"info": "The UUID of the image.: string",
"required": true,
"schema": {
"title": "imageId",
"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": "/deleteImage"
},
"task": true
},
{
"name": "showTasksAssociatedWithImage",
"summary": "Show tasks associated with image",
"description": "Show tasks associated with image",
"input": [
{
"name": "imageId",
"type": "string",
"info": "The UUID of the image.: string",
"required": true,
"schema": {
"title": "imageId",
"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": "/showTasksAssociatedWithImage"
},
"task": true
},
{
"name": "deactivateImage",
"summary": "Deactivate image",
"description": "Deactivate image",
"input": [
{
"name": "imageId",
"type": "string",
"info": "The UUID of the image.: string",
"required": true,
"schema": {
"title": "imageId",
"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": "/deactivateImage"
},
"task": true
},
{
"name": "reactivateImage",
"summary": "Reactivate image",
"description": "Reactivate image",
"input": [
{
"name": "imageId",
"type": "string",
"info": "The UUID of the image.: string",
"required": true,
"schema": {
"title": "imageId",
"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": "/reactivateImage"
},
"task": true
},
{
"name": "createImageMember",
"summary": "Create image member",
"description": "Create image member",
"input": [
{
"name": "imageId",
"type": "string",
"info": "The UUID of the image.: string",
"required": true,
"schema": {
"title": "imageId",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"member\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"properties": {
"member": {
"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": "/createImageMember"
},
"task": true
},
{
"name": "listImageMembers",
"summary": "List image members",
"description": "List image members",
"input": [
{
"name": "imageId",
"type": "string",
"info": "The UUID of the image.: string",
"required": true,
"schema": {
"title": "imageId",
"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": "/listImageMembers"
},
"task": true
},
{
"name": "showImageMemberDetails",
"summary": "Show image member details",
"description": "Show image member details",
"input": [
{
"name": "imageId",
"type": "string",
"info": "The UUID of the image.: string",
"required": true,
"schema": {
"title": "imageId",
"type": "string"
}
},
{
"name": "memberId",
"type": "string",
"info": "The ID of the image member. An image member is usually the project (also\ncalled the “tenant”) with whom the image is shared.: string",
"required": true,
"schema": {
"title": "memberId",
"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": "/showImageMemberDetails"
},
"task": true
},
{
"name": "updateImageMember",
"summary": "Update image member",
"description": "Update image member",
"input": [
{
"name": "imageId",
"type": "string",
"info": "The UUID of the image.: string",
"required": true,
"schema": {
"title": "imageId",
"type": "string"
}
},
{
"name": "memberId",
"type": "string",
"info": "The ID of the image member. An image member is usually the project (also\ncalled the “tenant”) with whom the image is shared.: string",
"required": true,
"schema": {
"title": "memberId",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"status\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"properties": {
"status": {
"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": "/updateImageMember"
},
"task": true
},
{
"name": "deleteImageMember",
"summary": "Delete image member",
"description": "Delete image member",
"input": [
{
"name": "imageId",
"type": "string",
"info": "The UUID of the image.: string",
"required": true,
"schema": {
"title": "imageId",
"type": "string"
}
},
{
"name": "memberId",
"type": "string",
"info": "The ID of the image member. An image member is usually the project (also\ncalled the “tenant”) with whom the image is shared.: string",
"required": true,
"schema": {
"title": "memberId",
"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": "/deleteImageMember"
},
"task": true
},
{
"name": "addImageTag",
"summary": "Add image tag",
"description": "Add image tag",
"input": [
{
"name": "imageId",
"type": "string",
"info": "The UUID of the image.: string",
"required": true,
"schema": {
"title": "imageId",
"type": "string"
}
},
{
"name": "tag",
"type": "string",
"info": "The image tag. A tag is limited to 255 chars in length. You may wish\nto use characters that can easily be written in a URL.: string",
"required": true,
"schema": {
"title": "tag",
"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": "/addImageTag"
},
"task": true
},
{
"name": "deleteImageTag",
"summary": "Delete image tag",
"description": "Delete image tag",
"input": [
{
"name": "imageId",
"type": "string",
"info": "The UUID of the image.: string",
"required": true,
"schema": {
"title": "imageId",
"type": "string"
}
},
{
"name": "tag",
"type": "string",
"info": "The image tag. A tag is limited to 255 chars in length. You may wish\nto use characters that can easily be written in a URL.: string",
"required": true,
"schema": {
"title": "tag",
"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": "/deleteImageTag"
},
"task": true
},
{
"name": "showImagesSchema",
"summary": "Show images schema",
"description": "Show images schema",
"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": "/showImagesSchema"
},
"task": true
},
{
"name": "showImageSchema",
"summary": "Show image schema",
"description": "Show image schema",
"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": "/showImageSchema"
},
"task": true
},
{
"name": "showImageMembersSchema",
"summary": "Show image members schema",
"description": "Show image members schema",
"input": [],
"output": {
"name": "result",
"type": "obj