summaryrefslogtreecommitdiffstats
path: root/components/pm-subscription-handler/pmsh_service/mod/api/pmsh_swagger.yml
blob: b88b9bf95cce6c52a9c54afe35c71d815766afce (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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
# ============LICENSE_START=======================================================
#  Copyright (C) 2020-2022 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: "2.0.0"
  description: PM subscription handler enables control of performance management jobs on network functions in ONAP
consumes:
  - "application/json"
produces:
  - "application/json"
basePath: "/"
schemes:
  - https
  - http
# Paths supported by the server application
paths:
  /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

  /subscription:
    post:
      tags:
        - "Subscription"
      description: >-
        Create a PM Subscription
      operationId: mod.api.controller.post_subscription
      parameters:
        - in: "body"
          name: "body"
          required: true
          schema:
            $ref: "#/definitions/subscription"
      responses:
        201:
          description: successfully created PM Subscription
        409:
          description: Duplicate data
        400:
          description: Invalid input

    get:
      description: Get all the subscriptions from PMSH.
      operationId: mod.api.controller.get_subscriptions
      tags:
        - "Subscription"
      responses:
        200:
          description: OK; Array of subscriptions are returned else empty if not found
          schema:
            type: array
            items:
              $ref: "#/definitions/subscription"
        500:
          description: Exception occurred while querying database

  /subscription/{subscription_name}:
    get:
      description: Get the Subscription from PMSH 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 occurred while querying database

    delete:
      description: Deletes the Subscription from PMSH specified by Name
      operationId: mod.api.controller.delete_subscription_by_name
      tags:
        - "Subscription"
      parameters:
        - name: subscription_name
          in: path
          required: true
          description: The name of the subscription to delete
          type: string
      responses:
        204:
          description: Successfully deleted the subscription and returns NO Content
        404:
          description: Subscription with the specified name not found
        409:
          description: Subscription could not be deleted as it contains measurement groups
                       with state UNLOCKED OR state change to LOCKED was under process
        500:
          description: Exception occurred on the server

  /subscription/{subscription_name}/nfFilter:
    put:
      tags:
        - "Subscription"
      description: >-
        Update a Subscription nf filter
      operationId: mod.api.controller.put_nf_filter
      parameters:
        - name: subscription_name
          in: path
          required: true
          description: The name of the subscription to update nf filters
          type: string
        - in: "body"
          name: "body"
          required: true
          schema:
            $ref: "#/definitions/nfFilter"
      responses:
        201:
          description: Successfully updated nf filter
        409:
          description: Conflicting data
        400:
          description: Invalid input
        500:
          description: Exception occurred while querying database

  /subscription/{subscription_name}/measurementGroups/{measurement_group_name}:
    post:
      description: Create a measurement group for a given subscription
      operationId: mod.api.controller.post_meas_group
      tags:
        - "Measurement Group"
      parameters:
        - name : subscription_name
          in: path
          required: true
          description: Name of the subscription
          type: string
        - name: measurement_group_name
          in: path
          required: true
          description: Name of the measurement group
          type: string
        - name: "body"
          in: "body"
          required: true
          schema:
            $ref: "#/definitions/measurementGroup"
      responses:
        201:
          description: Successfully created measurement group
        404:
          description: Subscription with the specified name not found
        409:
          description: Duplicate data
        500:
          description: Internal server error

    get:
      description: Get the  measurement group and associated network functions
                  from PMSH by using sub name and meas group name
      operationId: mod.api.controller.get_meas_group_with_nfs
      tags:
        - "Measurement Group"
      parameters:
        - name : subscription_name
          in: path
          required: true
          description: Name of the subscription
          type: string
        - name: measurement_group_name
          in: path
          required: true
          description: Name of the measurement group name
          type: string
      responses:
        200:
          description: OK; Received requested measurement group with associated NF's
          schema:
            $ref : "#/definitions/measGroupWithNFs"
        404:
          description: Measurement group with specified name not found
        500:
          description: Exception occurred while querying database

    delete:
      description: Delete a measurement group
      operationId: mod.api.controller.delete_meas_group_by_name
      tags:
        - "Measurement Group"
      parameters:
        - name : subscription_name
          in: path
          required: true
          description: Name of the subscription
          type: string
        - name: measurement_group_name
          in: path
          required: true
          description: Name of the measurement group name
          type: string
      responses:
        204:
          description: Successfully deleted the measurement group and returns NO Content
        404:
          description: Measurement group with the specified name not found
        409:
          description: Measurement group not deleted because state UNLOCKED OR state change to LOCKED was under process
        500:
          description: Exception occurred on the server

  /subscription/{subscription_name}/measurementGroups/{measurement_group_name}/adminState:
    put:
      description: Update the admin status of the Measurement Group by using sub name and measurement group name
      operationId: mod.api.controller.update_admin_state
      tags:
        - "Measurement Group"
      parameters:
        - name: subscription_name
          in: path
          required: true
          description: Name of the subscription
          type: string
        - name: measurement_group_name
          in: path
          required: true
          description: Name of the measurement group
          type: string
        - in: "body"
          name: "body"
          required: true
          schema:
            properties:
              administrativeState:
                type: string
                enum: [ LOCKED, UNLOCKED ]
      responses:
        200:
          description: Successfully updated admin state
        409:
          description: Cannot update as Locked request is in progress
        400:
          description: Invalid input request details
        500:
          description: Exception details of server failure

definitions:
  subscription:
    type: object
    properties:
      subscription:
        type: object
        properties:
          subscriptionName:
            type: string
          operationalPolicyName:
            type: string
          controlLoopName:
            type: string
          nfFilter:
            $ref: "#/definitions/nfFilter"
          measurementGroups:
            type: array
            minItems: 1
            items:
              $ref: "#/definitions/measurementGroup"
        required:
          - subscriptionName
          - operationalPolicyName
          - nfFilter
          - measurementGroups
    required:
      - subscription

  nfFilter:
    type: object
    description: "At least one valid filter value within nfFilter is required"
    additionalProperties: false
    properties:
      nfNames:
        type: array
        items:
          type: string
      modelInvariantIDs:
        type: array
        items:
          type: string
      modelVersionIDs:
        type: array
        items:
          type: string
      modelNames:
        type: array
        items:
          type: string
    required:
      - nfNames
      - modelInvariantIDs
      - modelVersionIDs
      - modelNames

  measurementGroup:
    type: object
    properties:
      measurementGroup:
        type: object
        properties:
          measurementGroupName:
            type: string
          fileBasedGP:
            type: integer
          fileLocation:
            type: string
          administrativeState:
            type: string
            enum: [LOCKED, UNLOCKED]
          measurementTypes:
            type: array
            minItems: 1
            items:
              $ref: "#/definitions/measurementType"
          managedObjectDNsBasic:
            type: array
            minItems: 1
            items:
              $ref: "#/definitions/managedObjectDNs"
        allOf:
          - required:
              - measurementGroupName
              - fileBasedGP
              - fileLocation
              - administrativeState
              - measurementTypes
              - managedObjectDNsBasic
    required:
      - measurementGroup

  measurementType:
    type: object
    properties:
      measurementType:
        type: string
    required:
      - measurementType

  managedObjectDNs:
    type: object
    properties:
      DN:
        type: string
    required:
      - DN

  measGroupWithNFs:
    type: object
    properties:
      subscriptionName:
        type: string
      measurementGroupName:
        type: string
      administrativeState:
        type: string
        enum: [ LOCKED, UNLOCKED ]
      fileBasedGP:
        type: integer
      fileLocation:
        type: string
      measurementTypes:
        type: array
        minItems: 1
        items:
          $ref: "#/definitions/measurementType"
      managedObjectDNsBasic:
        type: array
        minItems: 1
        items:
          $ref: "#/definitions/managedObjectDNs"
      network_functions:
        type: array
        items:
          type: object
          properties:
            nfName:
              type: string
              description: Name of the Network Function
            ipv4Address:
              type: string
              description: Address of the IPV4
            ipv6Address:
              type: string
              description: Address of the IPV6
            nfMgStatus:
              type: string
              description: status of network function for one meas group
            modelInvariantId:
              type: string
              description: ID of the model invariant
            modelVersionId:
              type: string
              description: ID of the model version
            modelName:
              type: string
              description: Name of the model
            sdncModelName:
              type: string
              description: Name of the sdnc model
            sdncModelVersion:
              type: string
              description: Version of the sdnc model