summaryrefslogtreecommitdiffstats
path: root/docs/api/swagger/openapi.yaml
blob: 14c721a3336c0da383535293f267b18d50e71cf8 (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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
openapi: 3.0.1
info:
  description: Adds Data Model Inventory Registry capability for ONAP
  title: NCMP DMI Plugin
  version: 1.0.0
servers:
- url: /dmi
tags:
- description: DMI plugin internal rest apis
  name: dmi-plugin-internal
- description: DMI plugin rest apis
  name: dmi-plugin
paths:
  /v1/ch/{cmHandle}/modules:
    post:
      description: Get all modules for given cm handle
      operationId: getModuleReferences
      parameters:
      - description: "The identifier for a network function, network element, subnetwork,\
          \ or any other cm object by managed Network CM Proxy"
        in: path
        name: cmHandle
        required: true
        schema:
          example: my-cm-handle
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModuleReferencesRequest'
        description: Operational body
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModuleSet'
          description: OK
        "404":
          content:
            application/json:
              example:
                status: 404
                message: Resource Not Found
                details: The requested resource is not found
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: The specified resource was not found
        "500":
          content:
            application/json:
              example:
                status: 500
                message: Internal Server Error
                details: Internal Server Error occured
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Internal Server Error
      summary: Get all modules for cm handle
      tags:
      - dmi-plugin
  /v1/ch/{cmHandle}/moduleResources:
    post:
      description: Retrieve module resources for one or more modules
      operationId: retrieveModuleResources
      parameters:
      - description: "The identifier for a network function, network element, subnetwork,\
          \ or any other cm object by managed Network CM Proxy"
        in: path
        name: cmHandle
        required: true
        schema:
          example: my-cm-handle
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModuleResourcesReadRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YangResources'
          description: OK
        "404":
          content:
            application/json:
              example:
                status: 404
                message: Resource Not Found
                details: The requested resource is not found
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: The specified resource was not found
        "500":
          content:
            application/json:
              example:
                status: 500
                message: Internal Server Error
                details: Internal Server Error occured
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Internal Server Error
      summary: Retrieve module resources
      tags:
      - dmi-plugin
  /v1/inventory/cmHandles:
    post:
      description: register given list of cm handles (internal use only)
      operationId: registerCmHandles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CmHandles'
        description: list of cm handles
        required: true
      responses:
        "201":
          content:
            text/plain:
              schema:
                example: cm-handle registered successfully
                type: string
          description: Created
        "400":
          content:
            application/json:
              example:
                status: 400
                message: Bad Request
                details: The provided request is not valid
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Bad Request
        "500":
          content:
            application/json:
              example:
                status: 500
                message: Internal Server Error
                details: Internal Server Error occured
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Internal Server Error
      summary: register given list of cm handles (internal use only)
      tags:
      - dmi-plugin-internal
      x-api-audience: component-internal
  /v1/ch/{cmHandle}/data/ds/{datastore-name}:
    post:
      description: Get resource data from passthrough operational or running for a
        cm handle
      operationId: dataAccessPassthrough
      parameters:
      - description: The type of the requested data
        in: path
        name: datastore-name
        required: true
        schema:
          example: ncmp-datastore:passthrough-operational or ncmp-datastore:passthrough-running
          type: string
      - description: "The identifier for a network function, network element, subnetwork,\
          \ or any other cm object by managed Network CM Proxy"
        in: path
        name: cmHandle
        required: true
        schema:
          example: my-cm-handle
          type: string
      - description: Resource identifier to get/set the resource data
        in: query
        name: resourceIdentifier
        required: true
        schema:
          example: my-schema:my-node
          type: string
      - description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
          \ in parenthesis'()'."
        examples:
          sample1:
            value:
              options: "(key1=value1,key2=value2)"
          sample2:
            value:
              options: "(key1=value1,key2=value1/value2)"
          sample3:
            value:
              options: "(key1=10,key2=value2,key3=val31,val32)"
        in: query
        name: options
        required: false
        schema:
          type: string
      - description: topic name passed from client(NCMP).
        examples:
          sample1:
            value: my-topic-name
        in: query
        name: topic
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataAccessRequest'
        description: Contains collection of cm handles with it's private properties
          and requestId
      responses:
        "200":
          content:
            application/json:
              schema:
                example:
                - yangSource: my-yang-source
                  moduleName: my-module-name
                  revision: my-revision
                type: object
          description: OK
        "400":
          content:
            application/json:
              example:
                status: 400
                message: Bad Request
                details: The provided request is not valid
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Bad Request
        "500":
          content:
            application/json:
              example:
                status: 500
                message: Internal Server Error
                details: Internal Server Error occured
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Internal Server Error
      summary: Get resource data from passthrough operational or running for a cm
        handle
      tags:
      - dmi-plugin
  /v1/data:
    post:
      description: Execute a data operation for group of cm handle ids by supplied
        operation details
      operationId: getResourceDataForCmHandleDataOperation
      parameters:
      - description: mandatory topic name passed from client(NCMP).
        examples:
          sample1:
            value:
              topic: my-topic-name
        in: query
        name: topic
        required: true
        schema:
          type: string
      - description: request Id generated by NCMP and sent as an acknowledgement for
          the client request the same including here.
        examples:
          sample1:
            value: 4753fc1f-7de2-449a-b306-a6204b5370b3
        in: query
        name: requestId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceDataOperationRequests'
        description: list of operation details
      responses:
        "202":
          description: Accepted
        "400":
          content:
            application/json:
              example:
                status: 400
                message: Bad Request
                details: The provided request is not valid
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Bad Request
        "500":
          content:
            application/json:
              example:
                status: 500
                message: Internal Server Error
                details: Internal Server Error occured
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Internal Server Error
        "501":
          content:
            application/json:
              example:
                status: 501
                message: Not Implemented
                details: Method Not Implemented
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Not Implemented
      summary: Execute a data operation for group of cm handle ids.
      tags:
      - dmi-plugin
components:
  parameters:
    cmHandleInPath:
      description: "The identifier for a network function, network element, subnetwork,\
        \ or any other cm object by managed Network CM Proxy"
      in: path
      name: cmHandle
      required: true
      schema:
        example: my-cm-handle
        type: string
    datastoreName:
      description: The type of the requested data
      in: path
      name: datastore-name
      required: true
      schema:
        example: ncmp-datastore:passthrough-operational or ncmp-datastore:passthrough-running
        type: string
    resourceIdentifierInQuery:
      description: Resource identifier to get/set the resource data
      in: query
      name: resourceIdentifier
      required: true
      schema:
        example: my-schema:my-node
        type: string
    optionsParamInQuery:
      description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
        \ in parenthesis'()'."
      examples:
        sample1:
          value:
            options: "(key1=value1,key2=value2)"
        sample2:
          value:
            options: "(key1=value1,key2=value1/value2)"
        sample3:
          value:
            options: "(key1=10,key2=value2,key3=val31,val32)"
      in: query
      name: options
      required: false
      schema:
        type: string
    topicParamInQuery:
      description: topic name passed from client(NCMP).
      examples:
        sample1:
          value: my-topic-name
      in: query
      name: topic
      required: false
      schema:
        type: string
    requiredTopicParamInQuery:
      description: mandatory topic name passed from client(NCMP).
      examples:
        sample1:
          value:
            topic: my-topic-name
      in: query
      name: topic
      required: true
      schema:
        type: string
    requiredRequestIdParamInQuery:
      description: request Id generated by NCMP and sent as an acknowledgement for
        the client request the same including here.
      examples:
        sample1:
          value: 4753fc1f-7de2-449a-b306-a6204b5370b3
      in: query
      name: requestId
      required: true
      schema:
        type: string
  responses:
    NotFound:
      content:
        application/json:
          example:
            status: 404
            message: Resource Not Found
            details: The requested resource is not found
          schema:
            $ref: '#/components/schemas/ErrorMessage'
      description: The specified resource was not found
    ServerError:
      content:
        application/json:
          example:
            status: 500
            message: Internal Server Error
            details: Internal Server Error occured
          schema:
            $ref: '#/components/schemas/ErrorMessage'
      description: Internal Server Error
    BadRequest:
      content:
        application/json:
          example:
            status: 400
            message: Bad Request
            details: The provided request is not valid
          schema:
            $ref: '#/components/schemas/ErrorMessage'
      description: Bad Request
    NotImplemented:
      content:
        application/json:
          example:
            status: 501
            message: Not Implemented
            details: Method Not Implemented
          schema:
            $ref: '#/components/schemas/ErrorMessage'
      description: Not Implemented
  schemas:
    ModuleReferencesRequest:
      example:
        moduleSetTag: moduleSetTag
        cmHandleProperties:
          key: "{\"prop1\":\"value1\",\"prop2\":\"value2\"}"
      properties:
        moduleSetTag:
          type: string
        cmHandleProperties:
          additionalProperties:
            example: "{\"prop1\":\"value1\",\"prop2\":\"value2\"}"
            type: string
          nullable: true
          type: object
      type: object
    cmHandleProperties:
      additionalProperties:
        example: "{\"prop1\":\"value1\",\"prop2\":\"value2\"}"
        type: string
      nullable: true
      type: object
    ModuleSet:
      example:
        schemas:
        - moduleName: my-module-name
          namespace: my-namespace
          revision: my-revision
        - moduleName: my-module-name
          namespace: my-namespace
          revision: my-revision
      properties:
        schemas:
          items:
            $ref: '#/components/schemas/ModuleSet_schemas_inner'
          type: array
      type: object
    ErrorMessage:
      properties:
        status:
          type: string
        message:
          type: string
        details:
          type: string
      title: Error
      type: object
    ModuleResourcesReadRequest:
      example:
        data:
          modules:
          - name: my-name
            revision: my-revision
          - name: my-name
            revision: my-revision
        moduleSetTag: Module-set-tag-1
        cmHandleProperties:
          key: "{\"prop1\":\"value1\",\"prop2\":\"value2\"}"
      properties:
        moduleSetTag:
          description: Module set tag of the given cm handle
          example: Module-set-tag-1
          type: string
        data:
          $ref: '#/components/schemas/ModuleResourcesReadRequest_data'
        cmHandleProperties:
          additionalProperties:
            example: "{\"prop1\":\"value1\",\"prop2\":\"value2\"}"
            type: string
          nullable: true
          type: object
      type: object
    YangResources:
      items:
        $ref: '#/components/schemas/YangResource'
      type: array
    YangResource:
      example:
        yangSource: my-yang-source
        moduleName: my-module-name
        revision: my-revision
      properties:
        yangSource:
          example: my-yang-source
          type: string
        moduleName:
          example: my-module-name
          type: string
        revision:
          example: my-revision
          type: string
    CmHandles:
      example:
        cmHandles:
        - cmHandleId1
        - cmHandleId2
        - cmHandleId3
      properties:
        cmHandles:
          example:
          - cmHandleId1
          - cmHandleId2
          - cmHandleId3
          items:
            type: string
          type: array
      type: object
    DataAccessRequest:
      example:
        data: my-data
        requestId: 3a9ce55c-e365-4dc9-8da3-a06f07cbc6d7
        dataType: my-data-type
        cmHandleProperties:
          key: "{\"prop1\":\"value1\",\"prop2\":\"value2\"}"
        moduleSetTag: module-set-tag1
        operation: read
      properties:
        operation:
          enum:
          - read
          - create
          - update
          - patch
          - delete
          example: read
          type: string
        dataType:
          example: my-data-type
          type: string
        data:
          example: my-data
          type: string
        cmHandleProperties:
          additionalProperties:
            example: "{\"prop1\":\"value1\",\"prop2\":\"value2\"}"
            type: string
          nullable: true
          type: object
        requestId:
          example: 3a9ce55c-e365-4dc9-8da3-a06f07cbc6d7
          type: string
        moduleSetTag:
          example: module-set-tag1
          type: string
      type: object
    ResourceDataOperationRequests:
      items:
        $ref: '#/components/schemas/DataOperationRequest'
      type: array
    dmiOperationCmHandle:
      example:
        id: cmHandle123
        cmHandleProperties:
          myProp: some value
          otherProp: other value
          moduleSetTag: module-set-tag1
      properties:
        id:
          type: string
        cmHandleProperties:
          additionalProperties:
            type: string
          type: object
        moduleSetTag:
          example: module-set-tag1
          type: string
      title: CmHandle with properties for DMI
      type: object
    ModuleSet_schemas_inner:
      example:
        moduleName: my-module-name
        namespace: my-namespace
        revision: my-revision
      properties:
        moduleName:
          example: my-module-name
          type: string
        revision:
          example: my-revision
          type: string
        namespace:
          example: my-namespace
          type: string
      type: object
    ModuleResourcesReadRequest_data_modules_inner:
      example:
        name: my-name
        revision: my-revision
      properties:
        name:
          example: my-name
          type: string
        revision:
          example: my-revision
          type: string
      type: object
    ModuleResourcesReadRequest_data:
      example:
        modules:
        - name: my-name
          revision: my-revision
        - name: my-name
          revision: my-revision
      properties:
        modules:
          items:
            $ref: '#/components/schemas/ModuleResourcesReadRequest_data_modules_inner'
          type: array
      type: object
    DataOperationRequest:
      example:
        resourceIdentifier: some resource identifier
        datastore: ncmp-datastore:passthrough-operational
        options: some option
        operationId: "12"
        cmHandles:
        - id: cmHandle123
          cmHandleProperties:
            myProp: some value
            otherProp: other value
            moduleSetTag: module-set-tag1
        - id: cmHandle123
          cmHandleProperties:
            myProp: some value
            otherProp: other value
            moduleSetTag: module-set-tag1
        operation: read
      properties:
        operation:
          example: read
          type: string
        operationId:
          description: it is recommended that the operationId is unique within the
            scope of the request
          example: "12"
          type: string
        datastore:
          example: ncmp-datastore:passthrough-operational
          type: string
        options:
          example: some option
          type: string
        resourceIdentifier:
          example: some resource identifier
          type: string
        cmHandles:
          items:
            $ref: '#/components/schemas/dmiOperationCmHandle'
          type: array
      required:
      - cmHandles
      - datastore
      - operation
      - operationId
      title: DataOperationRequest
      type: object