summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis/pmsh_swagger.json
diff options
context:
space:
mode:
authorefiacor <fiachra.corcoran@est.tech>2020-05-21 16:04:56 +0100
committerefiacor <fiachra.corcoran@est.tech>2020-05-25 11:00:48 +0100
commit1a06c541dddd9f14ffebc31436707e5897715e04 (patch)
tree82a50787f1304187d52be65591e0581fa56ea86f /docs/sections/apis/pmsh_swagger.json
parent3cf193ed20d9680b582f8e1fc3183390b79f962b (diff)
[PMSH] Adding new endpoint to api docs
Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: I97cea22d68155d58462ab801b022890c11790587 Issue-ID: DCAEGEN2-2154
Diffstat (limited to 'docs/sections/apis/pmsh_swagger.json')
-rw-r--r--docs/sections/apis/pmsh_swagger.json103
1 files changed, 103 insertions, 0 deletions
diff --git a/docs/sections/apis/pmsh_swagger.json b/docs/sections/apis/pmsh_swagger.json
new file mode 100644
index 00000000..59be8761
--- /dev/null
+++ b/docs/sections/apis/pmsh_swagger.json
@@ -0,0 +1,103 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "PM Subscription Handler Service",
+ "version": "1.1.0",
+ "description": "PM subscription handler enables control of performance management jobs on network functions in ONAP"
+ },
+ "produces": [
+ "application/json"
+ ],
+ "basePath": "/",
+ "schemes": [
+ "https"
+ ],
+ "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",
+ "tags": [
+ "HealthCheck"
+ ],
+ "description": "This is the health check endpoint. If this returns a 200, the server is alive.",
+ "responses": {
+ "200": {
+ "description": "Successful response",
+ "schema": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Overall health of PMSH",
+ "enum": [
+ "healthy",
+ "unhealthy"
+ ]
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "the pmsh service is unavailable"
+ }
+ }
+ }
+ }
+ }
+} \ No newline at end of file