Summary
Get JSON schemas of service models.
Description
Get JSON schemas of service models depending on service paths passed in.
Route
POST /nso_manager/serviceModel/schemas
Roles
admin
Parameters
Details Example Schema
Name
Type
Required
Description
options
object
yes
a list of options, e.g. models and adapter ID
Copied to Clipboard
{
"options": {
"options": {
"models": [
"/ncs:services/interface_description:interface_description",
"/ncs:services/asr1kModularService:customer-dns"
]
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"options": {
"type": "object",
"properties": {
"models": {
"type": "array",
"description": "a list of service paths",
"items": {
"type": "string",
"examples": [
"/ncs:services/interface_description:interface_description"
]
}
}
},
"examples": [
{
"options": {
"models": [
"/ncs:services/interface_description:interface_description",
"/ncs:services/asr1kModularService:customer-dns"
]
}
}
]
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
result
array
Converted JSON schemas mapped to their service paths.
Copied to Clipboard
{
"modelName": "nisi eiusmod",
"origin": "ipsum tempor elit fugiat"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"modelName": {
"type": "string",
"description": "indicates the service path"
},
"schema": {
"type": "object",
"description": "indicates the JSON schema for that particular service path"
},
"origin": {
"type": "string",
"description": "if there are same service paths across different NSO instances, then return the default schema or first schema that is configured"
}
}
}
