@itentialopensource/adapter-nokia_nsp_device_configurator
Version:
This adapter integrates with system described as: 22.11Modeled-deviceConfiguratorRestconfApis.
1,649 lines • 233 kB
JSON
{
"id": "@itentialopensource/adapter-nokia_nsp_device_configurator",
"type": "Adapter",
"export": "NokiaNspDeviceConfigurator",
"title": "Nokia_nsp_device_configurator",
"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"
}
},
{
"name": "persistFlag",
"type": "boolean",
"info": "Whether the input properties should be saved",
"required": true,
"schema": {
"title": "persistFlag",
"type": "boolean"
}
}
],
"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": [],
"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 IAP database",
"description": "Moves entities from an adapter into the IAP 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": "getAuthBearerToken",
"summary": "Get Auth Bearer Token",
"description": "Get a token from NSP server for the provided user",
"input": [
{
"name": "body",
"type": "object",
"info": ": object",
"required": true,
"schema": {
"allOf": [
{
"type": "object"
},
{
"example": {
"grant_type": "client_credentials"
}
}
],
"definitions": {}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"allOf": [
{
"title": "GetAuthBearerToken",
"required": [
"access_token",
"refresh_token",
"token_type",
"expires_in"
],
"type": "object",
"properties": {
"access_token": {
"type": "string"
},
"refresh_token": {
"type": "string"
},
"token_type": {
"type": "string"
},
"expires_in": {
"type": "integer"
}
},
"example": {
"access_token": "VEtOLWFkbWluYjcxY2RiMzMtYWZkMS00ZGY2LWFlMDktMDBiNmQ5OTYwNGQ5",
"refresh_token": "UkVUS04tYWRtaW41M2I3YWUwOS1iYzRlLTQ2N2UtOWEwYy0wMDljOTc0YjQ2YWY=",
"token_type": "Bearer",
"expires_in": 3600
}
},
{
"example": {
"access_token": "VEtOLWFkbWluYjcxY2RiMzMtYWZkMS00ZGY2LWFlMDktMDBiNmQ5OTYwNGQ5",
"refresh_token": "UkVUS04tYWRtaW41M2I3YWUwOS1iYzRlLTQ2N2UtOWEwYy0wMDljOTc0YjQ2YWY=",
"token_type": "Bearer",
"expires_in": 3600
}
}
]
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getAuthBearerToken"
},
"task": true
},
{
"name": "gettheRESTCONFRoot",
"summary": "1. Get the RESTCONF Root",
"description": "In this step discovering the RESTCONF API root is done.",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"allOf": [
{
"title": "1.GettheRESTCONFRoot",
"required": [
"links"
],
"type": "object",
"properties": {
"links": {
"type": "array",
"items": {
"title": "Link",
"required": [
"rel",
"href"
],
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"href": {
"type": "string"
}
},
"example": {
"rel": "restconf",
"href": "/restconf"
}
},
"description": ""
}
},
"example": {
"links": [
{
"rel": "restconf",
"href": "/restconf"
}
]
}
},
{
"example": {
"links": [
{
"rel": "restconf",
"href": "/restconf"
}
]
}
}
]
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/gettheRESTCONFRoot"
},
"task": true
},
{
"name": "getthedatastore",
"summary": "2. Get the data store",
"description": "Request to GET the root resource \"/restconf\"",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"allOf": [
{
"title": "2.Getthedatastore",
"required": [
"ietf-restconf:restconf"
],
"type": "object",
"properties": {
"ietf-restconf:restconf": {
"title": "IetfRestconfRestconf",
"required": [
"data",
"yang-library-version"
],
"type": "object",
"properties": {
"data": {
"type": "object"
},
"yang-library-version": {
"type": "string"
}
},
"example": {
"data": {},
"yang-library-version": "2019-01-04"
}
}
},
"example": {
"ietf-restconf:restconf": {
"data": {},
"yang-library-version": "2019-01-04"
}
}
},
{
"example": {
"ietf-restconf:restconf": {
"data": {},
"yang-library-version": "2019-01-04"
}
}
}
]
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/getthedatastore"
},
"task": true
},
{
"name": "gettheyangLibrary",
"summary": "3. Get the yang-library",
"description": "Lists the yang modules comprising the data model",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"allOf": [
{
"title": "3.Gettheyang-library",
"required": [
"ietf-yang-library:yang-library"
],
"type": "object",
"properties": {
"ietf-yang-library:yang-library": {
"title": "IetfYangLibraryYangLibrary",
"required": [
"content-id",
"module-set"
],
"type": "object",
"properties": {
"content-id": {
"type": "string"
},
"module-set": {
"type": "array",
"items": {
"title": "ModuleSet",
"required": [
"name",
"module"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"module": {
"type": "array",
"items": {
"title": "Module",
"required": [
"name",
"revision",
"namespace",
"conformance-type"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"revision": {
"type": "string"
},
"namespace": {
"type": "string"
},
"conformance-type": {
"type": "string"
}
},
"example": {
"name": "network-device-mgr",
"revision": "2018-06-06",
"namespace": "urn:nokia:nsp:mdm:network-device-mgr",
"conformance-type": "implement"
}
},
"description": ""
}
},
"example": {
"name": "NSP-MDC-2019-05-20",
"module": [
{
"name": "network-device-mgr",
"revision": "2018-06-06",
"namespace": "urn:nokia:nsp:mdm:network-device-mgr",
"conformance-type": "implement"
},
{
"name": "ietf-yang-library",
"revision": "2019-01-04",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-library",
"conformance-type": "implement"
},
{
"name": "ietf-yang-schema-mount",
"revision": "2017-10-09",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-schema-mount",
"conformance-type": "implement"
},
{
"name": "ietf-restconf",
"revision": "2016-08-15",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-restconf",
"conformance-type": "implement"
}
]
}
},
"description": ""
}
},
"example": {
"content-id": "NSP-2019-05-20",
"module-set": [
{
"name": "NSP-MDC-2019-05-20",
"module": [
{
"name": "network-device-mgr",
"revision": "2018-06-06",
"namespace": "urn:nokia:nsp:mdm:network-device-mgr",
"conformance-type": "implement"
},
{
"name": "ietf-yang-library",
"revision": "2019-01-04",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-library",
"conformance-type": "implement"
},
{
"name": "ietf-yang-schema-mount",
"revision": "2017-10-09",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-schema-mount",
"conformance-type": "implement"
},
{
"name": "ietf-restconf",
"revision": "2016-08-15",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-restconf",
"conformance-type": "implement"
}
]
}
]
}
}
},
"example": {
"ietf-yang-library:yang-library": {
"content-id": "NSP-2019-05-20",
"module-set": [
{
"name": "NSP-MDC-2019-05-20",
"module": [
{
"name": "network-device-mgr",
"revision": "2018-06-06",
"namespace": "urn:nokia:nsp:mdm:network-device-mgr",
"conformance-type": "implement"
},
{
"name": "ietf-yang-library",
"revision": "2019-01-04",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-library",
"conformance-type": "implement"
},
{
"name": "ietf-yang-schema-mount",
"revision": "2017-10-09",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-schema-mount",
"conformance-type": "implement"
},
{
"name": "ietf-restconf",
"revision": "2016-08-15",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-restconf",
"conformance-type": "implement"
}
]
}
]
}
}
},
{
"example": {
"ietf-yang-library:yang-library": {
"content-id": "NSP-2019-05-20",
"module-set": [
{
"name": "NSP-MDC-2019-05-20",
"module": [
{
"name": "network-device-mgr",
"revision": "2018-06-06",
"namespace": "urn:nokia:nsp:mdm:network-device-mgr",
"conformance-type": "implement"
},
{
"name": "ietf-yang-library",
"revision": "2019-01-04",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-library",
"conformance-type": "implement"
},
{
"name": "ietf-yang-schema-mount",
"revision": "2017-10-09",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-schema-mount",
"conformance-type": "implement"
},
{
"name": "ietf-restconf",
"revision": "2016-08-15",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-restconf",
"conformance-type": "implement"
}
]
}
]
}
}
}
]
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/gettheyangLibrary"
},
"task": true
},
{
"name": "gettheschemamounts",
"summary": "4. Get the schema mounts",
"description": "Request to GET the list of mount points and the yang modules where they are used.",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"allOf": [
{
"title": "4.Gettheschemamounts",
"required": [
"ietf-yang-schema-mounts:schema-mounts"
],
"type": "object",
"properties": {
"ietf-yang-schema-mounts:schema-mounts": {
"title": "IetfYangSchemaMountsSchemaMounts",
"required": [
"mount-point"
],
"type": "object",
"properties": {
"mount-point": {
"type": "array",
"items": {
"title": "MountPoint",
"required": [
"module",
"label",
"inline"
],
"type": "object",
"properties": {
"module": {
"type": "string"
},
"label": {
"type": "string"
},
"inline": {
"type": "object"
}
},
"example": {
"module": "ietf-network",
"label": "ne-management-nm",
"inline": {}
}
},
"description": ""
}
},
"example": {
"mount-point": [
{
"module": "ietf-network",
"label": "ne-management-nm",
"inline": {}
},
{
"module": "nsp-network",
"label": "node-root",
"inline": {}
},
{
"module": "ietf-network",
"label": "system-root",
"inline": {}
},
{
"module": "ietf-network",
"label": "protocol-root",
"inline": {}
},
{
"module": "ietf-network",
"label": "port-root",
"inline": {}
},
{
"module": "ietf-network",
"label": "interfaces-root",
"inline": {}
},
{
"module": "ietf-network",
"label": "routing-root",
"inline": {}
},
{
"module": "nsp-service-intent",
"label": "intent",
"inline": {}
},
{
"module": "nsp-tunnel-intent",
"label": "intent",
"inline": {}
},
{
"module": "network-device-mgr",
"label": "root",
"inline": {}
}
]
}
}
},
"example": {
"ietf-yang-schema-mounts:schema-mounts": {
"mount-point": [
{
"module": "ietf-network",
"label": "ne-management-nm",
"inline": {}
},
{
"module": "nsp-network",
"label": "node-root",
"inline": {}
},
{
"module": "ietf-network",
"label": "system-root",
"inline": {}
},
{
"module": "ietf-network",
"label": "protocol-root",
"inline": {}
},
{
"module": "ietf-network",
"label": "port-root",
"inline": {}
},
{
"module": "ietf-network",
"label": "interfaces-root",
"inline": {}
},
{
"module": "ietf-network",
"label": "routing-root",
"inline": {}
},
{
"module": "nsp-service-intent",
"label": "intent",
"inline": {}
},
{
"module": "nsp-tunnel-intent",
"label": "intent",
"inline": {}
},
{
"module": "network-device-mgr",
"label": "root",
"inline": {}
}
]
}
}
},
{
"example": {
"ietf-yang-schema-mounts:schema-mounts": {
"mount-point": [
{
"module": "ietf-network",
"label": "ne-management-nm",
"inline": {}
},
{
"module": "nsp-network",
"label": "node-root",
"inline": {}
},
{
"module": "ietf-network",
"label": "system-root",
"inline": {}
},
{
"module": "ietf-network",
"label": "protocol-root",
"inline": {}
},
{
"module": "ietf-network",
"label": "port-root",
"inline": {}
},
{
"module": "ietf-network",
"label": "interfaces-root",
"inline": {}
},
{
"module": "