blob: b93422364e89770b425ecaa0bb57d41c6c533c1d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
# ============LICENSE_START=======================================================
# Copyright (C) 2020 Nordix Foundation.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# ============LICENSE_END=========================================================
swagger: "2.0"
info:
title: PM Subscription Handler Service
version: "1.1.1"
description: PM subscription handler enables control of performance management jobs on network functions in ONAP
produces:
- "application/json"
basePath: "/"
schemes:
- https
# 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
model_invariant_id:
type: string
description: The NF model-invariant-id defined in A&AI
model_version_id:
type: string
description: The NF model-version-id defined in A&AI
sdnc_model_name:
type: string
description: The sdnc_model_name (blueprint name) defined in A&AI
sdnc_model_version:
type: string
description: The sdnc_model_version (blueprint version) defined in A&AI
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
|
