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.yml62
1 files changed, 22 insertions, 40 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 11cea4ee..f27fb7ab 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
@@ -31,46 +31,6 @@ schemes:
- http
# Paths supported by the server application
paths:
- /subscriptions:
- get:
- description: >-
- Get all defined Subscriptions and their related Network Functions from ONAP.
- operationId: mod.api.controller.get_all_sub_to_nf_relations
- responses:
- 200:
- description: OK; Array of subscriptions are returned as an object
- schema:
- type: array
- items:
- type: object
- properties:
- subscription_name:
- type: string
- description: Name of the Subscription
- subscription_status:
- type: string
- description: Status of the Subscription
- network_functions:
- type: array
- items:
- type: object
- properties:
- nf_name:
- type: string
- description: Name of the Network Function
- nf_sub_status:
- type: string
- description: Status of the Subscription on the Network Function
- orchestration_status:
- type: string
- description: Orchestration status of the Network Function
- 401:
- description: Unauthorized
- 403:
- description: Forbidden
- 404:
- description: there are no subscriptions defined
-
/healthcheck:
get:
operationId: mod.api.controller.status
@@ -112,6 +72,28 @@ paths:
400:
description: Invalid input
+ /subscription/{subscription_name}:
+ get:
+ description: Get the Subscription from ONAP specified by Name
+ operationId: mod.api.controller.get_subscription_by_name
+ tags:
+ - "Subscription"
+ parameters:
+ - name: subscription_name
+ in: path
+ required: true
+ description: Name of the subscription
+ type: string
+ responses:
+ 200:
+ description: OK; Requested Subscription was returned
+ schema:
+ $ref : "#/definitions/subscription"
+ 404:
+ description: Subscription with specified name not found
+ 500:
+ description: Exception occurs while querying database
+
definitions:
subscription:
type: object