summaryrefslogtreecommitdiffstats
path: root/components/pm-subscription-handler/pmsh_service/mod/api/pmsh_swagger.yml
diff options
context:
space:
mode:
authorraviteja.karumuri <raviteja.karumuri@est.tech>2021-12-02 19:13:27 +0000
committerraviteja.karumuri <raviteja.karumuri@est.tech>2021-12-14 12:18:50 +0000
commitc77c6d999abd83235798b20d7c76e1005f7135a3 (patch)
treee429604cbfbd45b9bc0409ae9571497ce2394f04 /components/pm-subscription-handler/pmsh_service/mod/api/pmsh_swagger.yml
parentadcbd374f47858f02a5155ec63d678442fb7f4a0 (diff)
[PMSH] Read NFS associated with MG by using MGName and subName
Issue-ID: DCAEGEN2-2993 Signed-off-by: Raviteja, Karumuri <raviteja.karumuri@est.tech> Change-Id: I651a687ab7480fc0d42bf976c3d1b34f00e73e98
Diffstat (limited to 'components/pm-subscription-handler/pmsh_service/mod/api/pmsh_swagger.yml')
-rw-r--r--components/pm-subscription-handler/pmsh_service/mod/api/pmsh_swagger.yml85
1 files changed, 85 insertions, 0 deletions
diff --git a/components/pm-subscription-handler/pmsh_service/mod/api/pmsh_swagger.yml b/components/pm-subscription-handler/pmsh_service/mod/api/pmsh_swagger.yml
index 39f6dc3b..4dd1cc70 100644
--- a/components/pm-subscription-handler/pmsh_service/mod/api/pmsh_swagger.yml
+++ b/components/pm-subscription-handler/pmsh_service/mod/api/pmsh_swagger.yml
@@ -109,6 +109,34 @@ paths:
500:
description: Exception occurred while querying database
+ /subscription/{subscription_name}/measurementGroups/{measurement_group_name}:
+ get:
+ description: Get the measurement group and associated network functions
+ from PMSH by using sub name and meas group name
+ operationId: mod.api.controller.get_meas_group_with_nfs
+ tags:
+ - "measurement group"
+ parameters:
+ - name : subscription_name
+ in: path
+ required: true
+ description: Name of the subscription
+ type: string
+ - name: measurement_group_name
+ in: path
+ required: true
+ description: Name of the measurement group name
+ type: string
+ responses:
+ 200:
+ description: OK; Received requested measurement group with associated NF's
+ schema:
+ $ref : "#/definitions/measGroupWithNFs"
+ 404:
+ description: Measurement group with specified name not found
+ 500:
+ description: Exception occurred while querying database
+
definitions:
subscription:
type: object
@@ -215,3 +243,60 @@ definitions:
type: string
required:
- DN
+
+ measGroupWithNFs:
+ type: object
+ properties:
+ subscriptionName:
+ type: string
+ measurementGroupName:
+ type: string
+ administrativeState:
+ type: string
+ enum: [ LOCKED, UNLOCKED ]
+ fileBasedGP:
+ type: integer
+ fileLocation:
+ type: string
+ measurementTypes:
+ type: array
+ minItems: 1
+ items:
+ $ref: "#/definitions/measurementType"
+ managedObjectDNsBasic:
+ type: array
+ minItems: 1
+ items:
+ $ref: "#/definitions/managedObjectDNs"
+ network_functions:
+ type: array
+ items:
+ type: object
+ properties:
+ nfName:
+ type: string
+ description: Name of the Network Function
+ ipv4Address:
+ type: string
+ description: Address of the IPV4
+ ipv6Address:
+ type: string
+ description: Address of the IPV6
+ nfMgStatus:
+ type: string
+ description: status of network function for one meas group
+ modelInvariantId:
+ type: string
+ description: ID of the model invariant
+ modelVersionId:
+ type: string
+ description: ID of the model version
+ modelName:
+ type: string
+ description: Name of the model
+ sdncModelName:
+ type: string
+ description: Name of the sdnc model
+ sdncModelVersion:
+ type: string
+ description: Version of the sdnc model