summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis
diff options
context:
space:
mode:
authorefiacor <fiachra.corcoran@est.tech>2020-09-18 14:59:44 +0100
committerefiacor <fiachra.corcoran@est.tech>2020-09-18 14:59:51 +0100
commit104d4a3e14a804e198ac1fc10eec0ab10cc33214 (patch)
treed786f2243e100e13e35e5068cd86be792af56556 /docs/sections/apis
parent0214cb3d22dc50baba3593569c01e151347a070f (diff)
[PMSH] Add multi CDS info etc
Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: I51ebf2034234f5e1726b2f240ad4059facc1d93e Issue-ID: DCAEGEN2-2407
Diffstat (limited to 'docs/sections/apis')
-rw-r--r--docs/sections/apis/PMSH.rst48
-rw-r--r--docs/sections/apis/pmsh_swagger.json18
-rw-r--r--docs/sections/apis/pmsh_swagger.yml15
3 files changed, 49 insertions, 32 deletions
diff --git a/docs/sections/apis/PMSH.rst b/docs/sections/apis/PMSH.rst
index 019e4ce9..a23c438c 100644
--- a/docs/sections/apis/PMSH.rst
+++ b/docs/sections/apis/PMSH.rst
@@ -44,22 +44,28 @@ The Subscription details are returned successfully
.. code-block:: javascript
[
- {
- "network_functions": [
- {
- "nf_name": "pnf102",
- "nf_sub_status": "PENDING_CREATE",
- "orchestration_status": "Active"
- },
- {
- "nf_name": "vnf101",
- "nf_sub_status": "CREATED",
- "orchestration_status": "Active"
- }
- ],
- "subscription_name": "demo-subscription",
- "subscription_status": "UNLOCKED"
- }
+ {
+ "subscription_name":"subscriptiona",
+ "subscription_status":"UNLOCKED",
+ "network_functions":[
+ {
+ "nf_name":"PNF104",
+ "nf_sub_status":"PENDING_CREATE",
+ "model_invariant_id":"8a57e2e6-d7ad-445f-b37e-a9837921014f",
+ "model_version_id":"d0938fd8-6fe4-42a2-9d26-82b7fa9336ad",
+ "sdnc_model_name":"pm_control",
+ "sdnc_model_version":"1.2.4"
+ },
+ {
+ "nf_name":"PNF105",
+ "nf_sub_status":"CREATED",
+ "model_invariant_id":"9a57e2e6-d7ad-445f-b37e-d6754892",
+ "model_version_id":"a0938fd8-6fe4-42a2-9d26-82b7fa93378c",
+ "sdnc_model_name":"pm_control",
+ "sdnc_model_version":"1.2.5"
+ }
+ ]
+ }
]
The subscription_status refers to the administrative status of the subscription.
@@ -72,16 +78,6 @@ The subscription_status refers to the administrative status of the subscription.
UNLOCKED, The Subscription is deployed / active.
-The network_functions.orchestration_status refers to the status of the xNF in AAI ONAP.
-
-.. csv-table:: Potential Values
- :header: "Status", "Description"
- :widths: 4,18
-
- Inventoried, The xNF has been on-boarded in ONAP but not yet operable.
- Active, The xNF is active and contactable.
-
-
The network_functions.nf_sub_status refers to the status of the subscription (PM Job) on the xNF.
.. csv-table:: Potential Values
diff --git a/docs/sections/apis/pmsh_swagger.json b/docs/sections/apis/pmsh_swagger.json
index 59be8761..ac15ca72 100644
--- a/docs/sections/apis/pmsh_swagger.json
+++ b/docs/sections/apis/pmsh_swagger.json
@@ -2,7 +2,7 @@
"swagger": "2.0",
"info": {
"title": "PM Subscription Handler Service",
- "version": "1.1.0",
+ "version": "1.1.1",
"description": "PM subscription handler enables control of performance management jobs on network functions in ONAP"
},
"produces": [
@@ -46,9 +46,21 @@
"type": "string",
"description": "Status of the Subscription on the Network Function"
},
- "orchestration_status": {
+ "model_invariant_id": {
"type": "string",
- "description": "Orchestration status of the Network Function"
+ "description": "The NF model-invariant-id defined in A&AI"
+ },
+ "model_version_id": {
+ "type": "string",
+ "description": "The NF model-version-id defined in A&AI"
+ },
+ "sdnc_model_name": {
+ "type": "string",
+ "description": "The sdnc_model_name (blueprint name) defined in A&AI"
+ },
+ "sdnc_model_version": {
+ "type": "string",
+ "description": "The sdnc_model_version (blueprint version) defined in A&AI"
}
}
}
diff --git a/docs/sections/apis/pmsh_swagger.yml b/docs/sections/apis/pmsh_swagger.yml
index 58e6a788..b9342236 100644
--- a/docs/sections/apis/pmsh_swagger.yml
+++ b/docs/sections/apis/pmsh_swagger.yml
@@ -19,7 +19,7 @@
swagger: "2.0"
info:
title: PM Subscription Handler Service
- version: "1.1.0"
+ version: "1.1.1"
description: PM subscription handler enables control of performance management jobs on network functions in ONAP
produces:
- "application/json"
@@ -58,9 +58,18 @@ paths:
nf_sub_status:
type: string
description: Status of the Subscription on the Network Function
- orchestration_status:
+ model_invariant_id:
type: string
- description: Orchestration status of the Network Function
+ description: The NF model-invariant-id defined in A&AI
+ model_version_id:
+ type: string
+ description: The NF model-version-id defined in A&AI
+ sdnc_model_name:
+ type: string
+ description: The sdnc_model_name (blueprint name) defined in A&AI
+ sdnc_model_version:
+ type: string
+ description: The sdnc_model_version (blueprint version) defined in A&AI
401:
description: Unauthorized
403: