@itentialopensource/adapter-etsi_sol005
Version:
This adapter integrates with system described as: ETSI sol005
1,548 lines • 8.14 MB
JSON
{
"openapi": "3.1.0",
"info": {
"title": "",
"version": "1.0.0"
},
"paths": {
"/nsd/v2/api_versions": {
"get": {
"tags": [
"ApiVersions"
],
"operationId": "getApiVersions",
"description": "The parameters and request body are for method: getApiVersions. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"uriPrefix": {
"type": "string"
},
"apiVersions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"version": {
"type": "string"
},
"isDeprecated": {
"type": "boolean"
},
"retirementDate": {
"type": "object"
}
}
}
}
}
},
"example": {
"uriPrefix": "string",
"apiVersions": [
{
"version": "string",
"isDeprecated": false,
"retirementDate": null
},
{
"version": "string",
"isDeprecated": false,
"retirementDate": null
},
{
"version": "string",
"isDeprecated": true,
"retirementDate": null
},
{
"version": "string",
"isDeprecated": true,
"retirementDate": null
},
{
"version": "string",
"isDeprecated": false,
"retirementDate": null
},
{
"version": "string",
"isDeprecated": false,
"retirementDate": null
},
{
"version": "string",
"isDeprecated": true,
"retirementDate": null
},
{
"version": "string",
"isDeprecated": true,
"retirementDate": null
},
{
"version": "string",
"isDeprecated": true,
"retirementDate": null
},
{
"version": "string",
"isDeprecated": false,
"retirementDate": null
}
]
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/nsd/v2/ns_descriptors": {
"post": {
"tags": [
"NsDescriptors"
],
"operationId": "postNsDescriptors",
"description": "The parameters and request body are for method: postNsDescriptors. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nsdId": {
"type": "string"
},
"nsdName": {
"type": "string"
},
"nsdVersion": {
"type": "string"
},
"nsdDesigner": {
"type": "string"
},
"nsdInvariantId": {
"type": "string"
},
"vnfPkgIds": {
"type": "array",
"items": {
"type": "string"
}
},
"pnfdInfoIds": {
"type": "array",
"items": {
"type": "string"
}
},
"nestedNsdInfoIds": {
"type": "array",
"items": {
"type": "string"
}
},
"archiveSecurityOption": {
"type": "string"
},
"signingCertificate": {
"type": "string"
},
"artifacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"artifactPath": {
"type": "string"
},
"checksum": {
"type": "object",
"properties": {
"algorithm": {
"type": "string"
},
"hash": {
"type": "string"
}
}
},
"metadata": {
"type": "object"
}
}
}
},
"nsdOnboardingState": {
"type": "string"
},
"onboardingFailureDetails": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "number"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
}
}
},
"nsdOperationalState": {
"type": "string"
},
"nsdUsageState": {
"type": "string"
},
"userDefinedData": {
"type": "object"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"nsd_content": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
}
}
}
}
},
"example": {
"id": "string",
"nsdId": "string",
"nsdName": "string",
"nsdVersion": "string",
"nsdDesigner": "string",
"nsdInvariantId": "string",
"vnfPkgIds": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"pnfdInfoIds": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"nestedNsdInfoIds": [
"string",
"string",
"string"
],
"archiveSecurityOption": "OPTION_2",
"signingCertificate": "string",
"artifacts": [
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
}
],
"nsdOnboardingState": "ONBOARDED",
"onboardingFailureDetails": {
"type": "string",
"title": "string",
"status": 3,
"detail": "string",
"instance": "string"
},
"nsdOperationalState": "DISABLED",
"nsdUsageState": "NOT_IN_USE",
"userDefinedData": {},
"_links": {
"self": {
"href": "string"
},
"nsd_content": {
"href": "string"
}
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"get": {
"tags": [
"NsDescriptors"
],
"operationId": "getNsDescriptors",
"description": "The parameters and request body are for method: getNsDescriptors. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nsdId": {
"type": "string"
},
"nsdName": {
"type": "string"
},
"nsdVersion": {
"type": "string"
},
"nsdDesigner": {
"type": "string"
},
"nsdInvariantId": {
"type": "string"
},
"vnfPkgIds": {
"type": "array",
"items": {
"type": "string"
}
},
"pnfdInfoIds": {
"type": "array",
"items": {
"type": "string"
}
},
"nestedNsdInfoIds": {
"type": "array",
"items": {
"type": "string"
}
},
"archiveSecurityOption": {
"type": "string"
},
"signingCertificate": {
"type": "string"
},
"artifacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"artifactPath": {
"type": "string"
},
"checksum": {
"type": "object",
"properties": {
"algorithm": {
"type": "string"
},
"hash": {
"type": "string"
}
}
},
"metadata": {
"type": "object"
}
}
}
},
"nsdOnboardingState": {
"type": "string"
},
"onboardingFailureDetails": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "number"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
}
}
},
"nsdOperationalState": {
"type": "string"
},
"nsdUsageState": {
"type": "string"
},
"userDefinedData": {
"type": "object"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"nsd_content": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"example": [
{
"id": "string",
"nsdId": "string",
"nsdName": "string",
"nsdVersion": "string",
"nsdDesigner": "string",
"nsdInvariantId": "string",
"vnfPkgIds": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"pnfdInfoIds": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"nestedNsdInfoIds": [
"string"
],
"archiveSecurityOption": "OPTION_2",
"signingCertificate": "string",
"artifacts": [
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
}
],
"nsdOnboardingState": "PROCESSING",
"onboardingFailureDetails": {
"type": "string",
"title": "string",
"status": 9,
"detail": "string",
"instance": "string"
},
"nsdOperationalState": "DISABLED",
"nsdUsageState": "NOT_IN_USE",
"userDefinedData": {},
"_links": {
"self": {
"href": "string"
},
"nsd_content": {
"href": "string"
}
}
},
{
"id": "string",
"nsdId": "string",
"nsdName": "string",
"nsdVersion": "string",
"nsdDesigner": "string",
"nsdInvariantId": "string",
"vnfPkgIds": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"pnfdInfoIds": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"nestedNsdInfoIds": [
"string",
"string",
"string"
],
"archiveSecurityOption": "OPTION_2",
"signingCertificate": "string",
"artifacts": [
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
}
],
"nsdOnboardingState": "ONBOARDED",
"onboardingFailureDetails": {
"type": "string",
"title": "string",
"status": 3,
"detail": "string",
"instance": "string"
},
"nsdOperationalState": "ENABLED",
"nsdUsageState": "IN_USE",
"userDefinedData": {},
"_links": {
"self": {
"href": "string"
},
"nsd_content": {
"href": "string"
}
}
},
{
"id": "string",
"nsdId": "string",
"nsdName": "string",
"nsdVersion": "string",
"nsdDesigner": "string",
"nsdInvariantId": "string",
"vnfPkgIds": [
"string",
"string",
"string",
"string"
],
"pnfdInfoIds": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"nestedNsdInfoIds": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"archiveSecurityOption": "OPTION_2",
"signingCertificate": "string",
"artifacts": [
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
}
],
"nsdOnboardingState": "PROCESSING",
"onboardingFailureDetails": {
"type": "string",
"title": "string",
"status": 5,
"detail": "string",
"instance": "string"
},
"nsdOperationalState": "DISABLED",
"nsdUsageState": "IN_USE",
"userDefinedData": {},
"_links": {
"self": {
"href": "string"
},
"nsd_content": {
"href": "string"
}
}
}
]
}
}
}
},
"parameters": [
{
"name": "filter",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "allFields",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fields",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "excludeFields",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "excludeDefault",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nextpageOpaqueMarker",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/nsd/v2/ns_descriptors/{nsdInfoId}": {
"get": {
"tags": [
"NsDescriptors"
],
"operationId": "getNsDescriptorsNsdInfoId",
"description": "The parameters and request body are for method: getNsDescriptorsNsdInfoId. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nsdId": {
"type": "string"
},
"nsdName": {
"type": "string"
},
"nsdVersion": {
"type": "string"
},
"nsdDesigner": {
"type": "string"
},
"nsdInvariantId": {
"type": "string"
},
"vnfPkgIds": {
"type": "array",
"items": {
"type": "string"
}
},
"pnfdInfoIds": {
"type": "array",
"items": {
"type": "string"
}
},
"nestedNsdInfoIds": {
"type": "array",
"items": {
"type": "string"
}
},
"archiveSecurityOption": {
"type": "string"
},
"signingCertificate": {
"type": "string"
},
"artifacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"artifactPath": {
"type": "string"
},
"checksum": {
"type": "object",
"properties": {
"algorithm": {
"type": "string"
},
"hash": {
"type": "string"
}
}
},
"metadata": {
"type": "object"
}
}
}
},
"nsdOnboardingState": {
"type": "string"
},
"onboardingFailureDetails": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "number"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
}
}
},
"nsdOperationalState": {
"type": "string"
},
"nsdUsageState": {
"type": "string"
},
"userDefinedData": {
"type": "object"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"nsd_content": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
}
}
}
}
},
"example": {
"id": "string",
"nsdId": "string",
"nsdName": "string",
"nsdVersion": "string",
"nsdDesigner": "string",
"nsdInvariantId": "string",
"vnfPkgIds": [
"string",
"string",
"string",
"string"
],
"pnfdInfoIds": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"nestedNsdInfoIds": [
"string",
"string",
"string",
"string"
],
"archiveSecurityOption": "OPTION_2",
"signingCertificate": "string",
"artifacts": [
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
},
{
"artifactPath": "string",
"checksum": {
"algorithm": "string",
"hash": "string"
},
"metadata": {}
}
],
"nsdOnboardingState": "CREATED",
"onboardingFailureDetails": {
"type": "string",
"title": "string",
"status": 2,
"detail": "string",
"instance": "string"
},
"nsdOperationalState": "DISABLED",
"nsdUsageState": "IN_USE",
"userDefinedData": {},
"_links": {
"self": {
"href": "string"
},
"nsd_content": {
"href": "string"
}
}
}
}
}
}
},
"parameters": [
{
"name": "nsdInfoId",
"in": "path",
"required": true,
"schema": {
"title": "nsdInfoId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"patch": {
"tags": [
"NsDescriptors"
],
"operationId": "patchNsDescriptorsNsdInfoId",
"description": "The parameters and request body are for method: patchNsDescriptorsNsdInfoId. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"nsdOperationalState": {
"type": "string"
},
"userDefinedData": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"example": {
"nsdOperationalState": "DISABLED",
"userDefinedData": [
{},
{},
{},
{},
{}
]
}
}
}
}
},
"parameters": [
{
"name": "nsdInfoId",
"in": "path",
"required": true,
"schema": {
"title": "nsdInfoId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"NsDescriptors"
],
"operationId": "deleteNsDescriptorsNsdInfoId",
"description": "The parameters and request body are for method: deleteNsDescriptorsNsdInfoId. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "nsdInfoId",
"in": "path",
"required": true,
"schema": {
"title": "nsdInfoId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/nsd/v2/ns_descriptors/{nsdInfoId}/nsd_content": {
"get": {
"tags": [
"NsDescriptors"
],
"operationId": "getNsDescriptorsNsdInfoIdNsdContent",
"description": "The parameters and request body are for method: getNsDescriptorsNsdInfoIdNsdContent. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "nsdInfoId",
"in": "path",
"required": true,
"schema": {
"title": "nsdInfoId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"NsDescriptors"
],
"operationId": "putNsDescriptorsNsdInfoIdNsdContent",
"description": "The parameters and request body are for method: putNsDescriptorsNsdInfoIdNsdContent. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "nsdInfoId",
"in": "path",
"required": true,
"schema": {
"title": "nsdInfoId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/nsd/v2/ns_descriptors/{nsdInfoId}/nsd": {
"get": {
"tags": [
"NsDescriptors"
],
"operationId": "getNsDescriptorsNsdInfoIdNsd",
"description": "The parameters and request body are for method: getNsDescriptorsNsdInfoIdNsd. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "nsdInfoId",
"in": "path",
"required": true,
"schema": {
"title": "nsdInfoId",
"type": "string"
}
},
{
"name": "includeSignatures",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/nsd/v2/ns_descriptors/{nsdInfoId}/manifest": {
"get": {
"tags": [
"NsDescriptors"
],
"operationId": "getNsDescriptorsNsdInfoIdManifest",
"description": "The parameters and request body are for method: getNsDescriptorsNsdInfoIdManifest. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "nsdInfoId",
"in": "path",
"required": true,
"schema": {
"title": "nsdInfoId",
"type": "string"
}
},
{
"name": "includeSignatures",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/nsd/v2/ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}": {
"get": {
"tags": [
"NsDescriptors"
],
"operationId": "getNsDescriptorsNsdInfoIdArtifactsArtifactPath",
"description": "The parameters and request body are for method: getNsDescriptorsNsdInfoIdArtifactsArtifactPath. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "nsdInfoId",
"in": "path",
"required": true,
"schema": {
"title": "nsdInfoId",
"type": "string"
}
},
{
"name": "artifactPath",
"in": "path"