| efiacor | 1a06c54 | 2020-05-21 16:04:56 +0100 | [diff] [blame] | 1 | { |
| 2 | "swagger": "2.0", |
| 3 | "info": { |
| 4 | "title": "PM Subscription Handler Service", |
| 5 | "version": "1.1.0", |
| 6 | "description": "PM subscription handler enables control of performance management jobs on network functions in ONAP" |
| 7 | }, |
| 8 | "produces": [ |
| 9 | "application/json" |
| 10 | ], |
| 11 | "basePath": "/", |
| 12 | "schemes": [ |
| 13 | "https" |
| 14 | ], |
| 15 | "paths": { |
| 16 | "/subscriptions": { |
| 17 | "get": { |
| 18 | "description": "Get all defined Subscriptions and their related Network Functions from ONAP.", |
| 19 | "operationId": "mod.api.controller.get_all_sub_to_nf_relations", |
| 20 | "responses": { |
| 21 | "200": { |
| 22 | "description": "OK; Array of subscriptions are returned as an object", |
| 23 | "schema": { |
| 24 | "type": "array", |
| 25 | "items": { |
| 26 | "type": "object", |
| 27 | "properties": { |
| 28 | "subscription_name": { |
| 29 | "type": "string", |
| 30 | "description": "Name of the Subscription" |
| 31 | }, |
| 32 | "subscription_status": { |
| 33 | "type": "string", |
| 34 | "description": "Status of the Subscription" |
| 35 | }, |
| 36 | "network_functions": { |
| 37 | "type": "array", |
| 38 | "items": { |
| 39 | "type": "object", |
| 40 | "properties": { |
| 41 | "nf_name": { |
| 42 | "type": "string", |
| 43 | "description": "Name of the Network Function" |
| 44 | }, |
| 45 | "nf_sub_status": { |
| 46 | "type": "string", |
| 47 | "description": "Status of the Subscription on the Network Function" |
| 48 | }, |
| 49 | "orchestration_status": { |
| 50 | "type": "string", |
| 51 | "description": "Orchestration status of the Network Function" |
| 52 | } |
| 53 | } |
| 54 | } |
| 55 | } |
| 56 | } |
| 57 | } |
| 58 | } |
| 59 | }, |
| 60 | "401": { |
| 61 | "description": "Unauthorized" |
| 62 | }, |
| 63 | "403": { |
| 64 | "description": "Forbidden" |
| 65 | }, |
| 66 | "404": { |
| 67 | "description": "there are no subscriptions defined" |
| 68 | } |
| 69 | } |
| 70 | } |
| 71 | }, |
| 72 | "/healthcheck": { |
| 73 | "get": { |
| 74 | "operationId": "mod.api.controller.status", |
| 75 | "tags": [ |
| 76 | "HealthCheck" |
| 77 | ], |
| 78 | "description": "This is the health check endpoint. If this returns a 200, the server is alive.", |
| 79 | "responses": { |
| 80 | "200": { |
| 81 | "description": "Successful response", |
| 82 | "schema": { |
| 83 | "type": "object", |
| 84 | "properties": { |
| 85 | "status": { |
| 86 | "type": "string", |
| 87 | "description": "Overall health of PMSH", |
| 88 | "enum": [ |
| 89 | "healthy", |
| 90 | "unhealthy" |
| 91 | ] |
| 92 | } |
| 93 | } |
| 94 | } |
| 95 | }, |
| 96 | "503": { |
| 97 | "description": "the pmsh service is unavailable" |
| 98 | } |
| 99 | } |
| 100 | } |
| 101 | } |
| 102 | } |
| 103 | } |