summaryrefslogtreecommitdiffstats
path: root/components/pm-subscription-handler/pmsh_service/mod/api/pmsh_swagger.yml
diff options
context:
space:
mode:
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.yml34
1 files changed, 29 insertions, 5 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 2a6137cf..11cea4ee 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
@@ -21,6 +21,8 @@ info:
title: PM Subscription Handler Service
version: "2.0.0"
description: PM subscription handler enables control of performance management jobs on network functions in ONAP
+consumes:
+ - "application/json"
produces:
- "application/json"
basePath: "/"
@@ -89,6 +91,27 @@ paths:
503:
description: the pmsh service is unavailable
+ /subscription:
+ post:
+ tags:
+ - "Subscription"
+ description: >-
+ Create a PM Subscription
+ operationId: mod.api.controller.post_subscription
+ parameters:
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/subscription"
+ responses:
+ 201:
+ description: successfully created PM Subscription
+ 409:
+ description: Duplicate data
+ 400:
+ description: Invalid input
+
definitions:
subscription:
type: object
@@ -119,29 +142,30 @@ definitions:
nfFilter:
type: object
- minProperties: 1
+ description: "At least one valid filter value within nfFilter is required"
additionalProperties: false
properties:
nfNames:
type: array
- minItems: 1
items:
type: string
modelInvariantIDs:
type: array
- minItems: 1
items:
type: string
modelVersionIDs:
type: array
- minItems: 1
items:
type: string
modelNames:
type: array
- minItems: 1
items:
type: string
+ required:
+ - nfNames
+ - modelInvariantIDs
+ - modelVersionIDs
+ - modelNames
measurementGroup:
type: object