@itentialopensource/adapter-paragon_dpm
Version:
This adapter integrates with system described as: naas/ems/dpm/proto/rpc.proto.
1,647 lines • 284 kB
JSON
{
"id": "@itentialopensource/adapter-paragon_dpm",
"type": "Adapter",
"export": "ParagonDpm",
"title": "Paragon_dpm",
"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": "dpmServiceExtRefUpdate",
"summary": "External reference update",
"description": "This API can be used to create/delete reference for ExtRef table.",
"input": [
{
"name": "body",
"type": "object",
"info": ": {\"ref-from-type\": \"string\", \"ref-from-uuid\": \"string\", \"operation\": \"string\", \"ref-to-uuid\": \"string\", \"ref-to-type\": \"string\"}",
"required": true,
"schema": {
"type": "object",
"properties": {
"ref-from-type": {
"type": "string"
},
"ref-from-uuid": {
"type": "string"
},
"operation": {
"type": "string"
},
"ref-to-uuid": {
"type": "string"
},
"ref-to-type": {
"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": "/dpmServiceExtRefUpdate"
},
"task": true
},
{
"name": "dpmServiceBulkListDeletedResource",
"summary": "Bulk list deleted-resources",
"description": "This API can be used to list deleted-resource based on specification given in request body.",
"input": [
{
"name": "body",
"type": "object",
"info": ": {\"spec\": {\"ref_fields\": \"array\", \"parent_type\": \"string\", \"filters\": \"array\", \"operation\": \"Must be one of [AND, OR]\", \"json_filters\": [{\"values\": \"array\", \"key\": \"string\"}], \"size\": \"string\", \"from\": \"string\", \"page_marker\": \"string\", \"obj_uuids\": \"array\", \"ref_uuids_map\": \"object\", \"detail\": \"boolean\", \"parent_id\": \"array\", \"ext_ref_uuids\": \"array\", \"back_ref_id\": \"array\", \"exclude_shared\": \"boolean\", \"exclude_hrefs\": \"boolean\", \"tag_detail\": \"boolean\", \"count\": \"boolean\", \"fields\": \"array\", \"parent_fq_name_str\": \"array\", \"ref_uuids\": \"array\", \"sortby\": \"string\", \"tag_filters\": \"array\"}}",
"required": true,
"schema": {
"type": "object",
"properties": {
"spec": {
"type": "object",
"properties": {
"ref_fields": {
"items": {
"type": "string"
},
"type": "array",
"title": "limit displayed reference fields"
},
"parent_type": {
"type": "string",
"title": "Filter by parent type"
},
"filters": {
"items": {
"type": "string"
},
"type": "array",
"title": "QueryFilter in string format.\nGrpc-gateway doesn't have support for nested structs and maps so\nintroducing new fields which will take string as input"
},
"operation": {
"default": "AND",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"json_filters": {
"items": {
"type": "object",
"properties": {
"values": {
"items": {
"type": "string"
},
"type": "array",
"title": "Filter values"
},
"key": {
"type": "string",
"title": "Filter key"
}
}
},
"type": "array",
"title": "QueryFilter in JSON Format"
},
"size": {
"title": "Number of items expected to be returned",
"type": "string"
},
"from": {
"title": "Start from items expected to be returned",
"type": "string"
},
"page_marker": {
"type": "string",
"description": "Include only objects with UUID lexically greater than this."
},
"obj_uuids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Filter by UUIDs"
},
"ref_uuids_map": {
"additionalProperties": {
"type": "object",
"properties": {
"uuids": {
"items": {
"type": "string"
},
"type": "array",
"title": "UUIDs for refs and backrefs"
}
}
},
"type": "object",
"title": "Filter by ref UUIDss"
},
"detail": {
"title": "Include detail informatoin or not",
"type": "boolean"
},
"parent_id": {
"items": {
"type": "string"
},
"type": "array",
"title": "Filter by parent UUIDs"
},
"ext_ref_uuids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Filter by External Ref UUIDss"
},
"back_ref_id": {
"items": {
"type": "string"
},
"type": "array",
"title": "Filter by backref UUIDss"
},
"exclude_shared": {
"title": "Include shared resources or not",
"type": "boolean"
},
"exclude_hrefs": {
"title": "Exclude href parameters",
"type": "boolean"
},
"tag_detail": {
"title": "Include Tag Details or not",
"type": "boolean"
},
"count": {
"type": "boolean"
},
"fields": {
"items": {
"type": "string"
},
"type": "array",
"title": "limit displayed fields"
},
"parent_fq_name_str": {
"items": {
"type": "string"
},
"type": "array",
"title": "Filter by parent FQ Name"
},
"ref_uuids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Filter by ref UUIDss"
},
"sortby": {
"type": "string",
"title": "Sort by column with ascending or descending by default ascending"
},
"tag_filters": {
"items": {
"type": "string"
},
"type": "array",
"title": "Filter by Tag Fields"
}
}
}
},
"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": "/dpmServiceBulkListDeletedResource"
},
"task": true
},
{
"name": "dpmServiceCreateCaCertificateBlob",
"summary": "Create ca-certificate-blob",
"description": "Create ca-certificate-blob",
"input": [
{
"name": "body",
"type": "object",
"info": ": {\"ca-certificate-blob\": {\"updated_timestamp\": \"string\", \"description\": \"string\", \"configuration_version\": \"string\", \"device_uuid\": \"string\", \"href\": \"string\", \"certificate_contents\": \"string\", \"parent_type\": \"string\", \"uuid\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"name\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"boolean\"}, \"created_by\": \"string\", \"updated_by\": \"string\", \"created_timestamp\": \"string\", \"annotations\": {\"key_value_pair\": [{\"key\": \"string\", \"value\": \"string\"}]}, \"parent_uuid\": \"string\"}}",
"required": true,
"schema": {
"type": "object",
"properties": {
"ca-certificate-blob": {
"type": "object",
"properties": {
"updated_timestamp": {
"title": "Updated Timestamp for the object",
"type": "string"
},
"description": {
"type": "string",
"title": "Description of the object"
},
"configuration_version": {
"type": "string",
"description": "Configuration Version for the object."
},
"device_uuid": {
"type": "string",
"title": "uuid of the associated device"
},
"href": {
"type": "string",
"title": "Instance reference URL"
},
"certificate_contents": {
"title": "ca certificate contents",
"type": "string"
},
"parent_type": {
"type": "string",
"title": "Parent resource type"
},
"uuid": {
"type": "string",
"title": "UUID of the object, system automatically allocates one if not provided"
},
"perms2": {
"type": "object",
"properties": {
"owner": {
"type": "string",
"title": "Owner project of the object"
},
"global_access": {
"title": "Share the object globally",
"type": "string"
},
"share": {
"items": {
"type": "object",
"properties": {
"access": {
"title": "Allowed permissions in sharing",
"type": "string"
},
"scope": {
"type": "string",
"title": "ID of the scope to which the object is shared"
},
"levels": {
"title": "Number of level to which share should be applied",
"type": "string"
},
"scope_types": {
"items": {
"type": "string"
},
"type": "array",
"title": "Only apply share for specific types"
}
}
},
"type": "array",
"title": "Selectively shared object, List of (project, permissions)"
}
}
},
"name": {
"type": "string",
"title": "Name of the object, defaults to 'default-<resource-type>'"
},
"meta": {
"type": "object",
"properties": {
"enable": {
"title": "Administratively Enable/Disable this object",
"type": "boolean"
},
"user_visible": {
"title": "System created internal objects will have this flag set and will not be visible",
"type": "boolean"
}
}
},
"created_by": {
"type": "string",
"title": "user who created this object"
},
"updated_by": {
"type": "string",
"title": "user who updated this object"
},
"created_timestamp": {
"title": "Created Timestamp for the object",
"type": "string"
},
"annotations": {
"type": "object",
"properties": {
"key_value_pair": {
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"type": "array"
}
}
},
"parent_uuid": {
"type": "string",
"title": "UUID of the parent object"
}
}
}
},
"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": "/dpmServiceCreateCaCertificateBlob"
},
"task": true
},
{
"name": "dpmServiceListCaCertificateBlob",
"summary": "List ca-certificate-blobs",
"description": "This API can be used to list ca-certificate-blob based on specification given in query parameters.",
"input": [
{
"name": "specSize",
"type": "string",
"info": "Number of items expected to be returned.: string",
"required": false,
"schema": {
"title": "specSize",
"type": "string"
}
},
{
"name": "specPageMarker",
"type": "string",
"info": "Include only objects with UUID lexically greater than this.: string",
"required": false,
"schema": {
"title": "specPageMarker",
"type": "string"
}
},
{
"name": "specDetail",
"type": "boolean",
"info": "Include detail informatoin or not.: boolean",
"required": false,
"schema": {
"title": "specDetail",
"type": "boolean"
}
},
{
"name": "specCount",
"type": "boolean",
"info": ": boolean",
"required": false,
"schema": {
"title": "specCount",
"type": "boolean"
}
},
{
"name": "specExcludeShared",
"type": "boolean",
"info": "Include shared resources or not.: boolean",
"required": false,
"schema": {
"title": "specExcludeShared",
"type": "boolean"
}
},
{
"name": "specExcludeHrefs",
"type": "boolean",
"info": "Exclude href parameters.: boolean",
"required": false,
"schema": {
"title": "specExcludeHrefs",
"type": "boolean"
}
},
{
"name": "specParentFqNameStr",
"type": "array",
"info": "Filter by parent FQ Name.: array",
"required": false,
"schema": {
"title": "specParentFqNameStr",
"type": "array"
}
},
{
"name": "specParentType",
"type": "string",
"info": "Filter by parent type.: string",
"required": false,
"schema": {
"title": "specParentType",
"type": "string"
}
},
{
"name": "specParentId",
"type": "array",
"info": "Filter by parent UUIDs.: array",
"required": false,
"schema": {
"title": "specParentId",
"type": "array"
}
},
{
"name": "specBackRefId",
"type": "array",
"info": "Filter by backref UUIDss.: array",
"required": false,
"schema": {
"title": "specBackRefId",
"type": "array"
}
},
{
"name": "specObjUuids",
"type": "array",
"info": "Filter by UUIDs.: array",
"required": false,
"schema": {
"title": "specObjUuids",
"type": "array"
}
},
{
"name": "specFields",
"type": "array",
"info": "limit displayed fields.: array",
"required": false,
"schema": {
"title": "specFields",
"type": "array"
}
},
{
"name": "specFilters",
"type": "array",
"info": "QueryFilter in string format.\nGrpc-gateway doesn't have support for nested structs and maps so\nintroducing new fields which will take string as input.: array",
"required": false,
"schema": {
"title": "specFilters",
"type": "array"
}
},
{
"name": "specRefUuids",
"type": "array",
"info": "Filter by ref UUIDss.: array",
"required": false,
"schema": {
"title": "specRefUuids",
"type": "array"
}
},
{
"name": "specFrom",
"type": "string",
"info": "Start from items expected to be returned.: string",
"required": false,
"schema": {
"title": "specFrom",
"type": "string"
}
},
{
"name": "specSortby",
"type": "string",
"info": "Sort by column with ascending or descending by default ascending.: string",
"required": false,
"schema": {
"title": "specSortby",
"type": "string"
}
},
{
"name": "specOperation",
"type": "string",
"info": "Operation determines whether union or interjection.: Must be one of [AND, OR]",
"required": false,
"schema": {
"title": "specOperation",
"type": "string"
}
},
{
"name": "specTagFilters",
"type": "array",
"info": "Filter by Tag Fields.: array",
"required": false,
"schema": {
"title": "specTagFilters",
"type": "array"
}
},
{
"name": "specTagDetail",
"type": "boolean",
"info": "Include Tag Details or not.: boolean",
"required": false,
"schema": {
"title": "specTagDetail",
"type": "boolean"
}
},
{
"name": "specRefFields",
"type": "array",
"info": "limit displayed reference fields.: array",
"required": false,
"schema": {
"title": "specRefFields",
"type": "array"
}
},
{
"name": "specExtRefUuids",
"type": "array",
"info": "Filter by External Ref UUIDss.: array",
"required": false,
"schema": {
"title": "specExtRefUuids",
"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": "/dpmServiceListCaCertificateBlob"
},
"task": true
},
{
"name": "dpmServiceCreateLastPublishedNotification",
"summary": "Create last-published-notification",
"description": "Create last-published-notification",
"input": [
{
"name": "body",
"type": "object",
"info": ": {\"last-published-notification\": {\"updated_timestamp\": \"string\", \"last_published_timestamp\": \"string\", \"description\": \"string\", \"configuration_version\": \"string\", \"href\": \"string\", \"parent_type\": \"string\", \"uuid\": \"string\", \"perms2\": {\"owner\": \"string\", \"global_access\": \"string\", \"share\": [{\"access\": \"string\", \"scope\": \"string\", \"levels\": \"string\", \"scope_types\": \"array\"}]}, \"name\": \"string\", \"meta\": {\"enable\": \"boolean\", \"user_visible\": \"bo