| efiacor | 1a06c54 | 2020-05-21 16:04:56 +0100 | [diff] [blame] | 1 | # ============LICENSE_START======================================================= |
| 2 | # Copyright (C) 2020 Nordix Foundation. |
| 3 | # ================================================================================ |
| 4 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | # you may not use this file except in compliance with the License. |
| 6 | # You may obtain a copy of the License at |
| 7 | # |
| 8 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | # |
| 10 | # Unless required by applicable law or agreed to in writing, software |
| 11 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | # See the License for the specific language governing permissions and |
| 14 | # limitations under the License. |
| 15 | # |
| 16 | # SPDX-License-Identifier: Apache-2.0 |
| 17 | # ============LICENSE_END========================================================= |
| 18 | |
| 19 | swagger: "2.0" |
| 20 | info: |
| 21 | title: PM Subscription Handler Service |
| efiacor | 104d4a3 | 2020-09-18 14:59:44 +0100 | [diff] [blame] | 22 | version: "1.1.1" |
| efiacor | 1a06c54 | 2020-05-21 16:04:56 +0100 | [diff] [blame] | 23 | description: PM subscription handler enables control of performance management jobs on network functions in ONAP |
| 24 | produces: |
| 25 | - "application/json" |
| 26 | basePath: "/" |
| 27 | schemes: |
| 28 | - https |
| 29 | # Paths supported by the server application |
| 30 | paths: |
| 31 | /subscriptions: |
| 32 | get: |
| 33 | description: >- |
| 34 | Get all defined Subscriptions and their related Network Functions from ONAP. |
| 35 | operationId: mod.api.controller.get_all_sub_to_nf_relations |
| 36 | responses: |
| 37 | 200: |
| 38 | description: OK; Array of subscriptions are returned as an object |
| 39 | schema: |
| 40 | type: array |
| 41 | items: |
| 42 | type: object |
| 43 | properties: |
| 44 | subscription_name: |
| 45 | type: string |
| 46 | description: Name of the Subscription |
| 47 | subscription_status: |
| 48 | type: string |
| 49 | description: Status of the Subscription |
| 50 | network_functions: |
| 51 | type: array |
| 52 | items: |
| 53 | type: object |
| 54 | properties: |
| 55 | nf_name: |
| 56 | type: string |
| 57 | description: Name of the Network Function |
| 58 | nf_sub_status: |
| 59 | type: string |
| 60 | description: Status of the Subscription on the Network Function |
| efiacor | 104d4a3 | 2020-09-18 14:59:44 +0100 | [diff] [blame] | 61 | model_invariant_id: |
| efiacor | 1a06c54 | 2020-05-21 16:04:56 +0100 | [diff] [blame] | 62 | type: string |
| efiacor | 104d4a3 | 2020-09-18 14:59:44 +0100 | [diff] [blame] | 63 | description: The NF model-invariant-id defined in A&AI |
| 64 | model_version_id: |
| 65 | type: string |
| 66 | description: The NF model-version-id defined in A&AI |
| 67 | sdnc_model_name: |
| 68 | type: string |
| 69 | description: The sdnc_model_name (blueprint name) defined in A&AI |
| 70 | sdnc_model_version: |
| 71 | type: string |
| 72 | description: The sdnc_model_version (blueprint version) defined in A&AI |
| efiacor | 1a06c54 | 2020-05-21 16:04:56 +0100 | [diff] [blame] | 73 | 401: |
| 74 | description: Unauthorized |
| 75 | 403: |
| 76 | description: Forbidden |
| 77 | 404: |
| 78 | description: there are no subscriptions defined |
| 79 | |
| 80 | /healthcheck: |
| 81 | get: |
| 82 | operationId: mod.api.controller.status |
| 83 | tags: |
| 84 | - "HealthCheck" |
| 85 | description: >- |
| 86 | This is the health check endpoint. If this returns a 200, the server is alive. |
| 87 | responses: |
| 88 | 200: |
| 89 | description: Successful response |
| 90 | schema: |
| 91 | type: object |
| 92 | properties: |
| 93 | status: |
| 94 | type: string |
| 95 | description: Overall health of PMSH |
| 96 | enum: [healthy, unhealthy] |
| 97 | 503: |
| 98 | description: the pmsh service is unavailable |