docs/api/swagger/ncmp/openapi.yaml

   1 openapi: 3.0.1
   2 info:
   3   title: NCMP to CPS Proxy API
   4   description: NCMP to CPS Proxy API
   5   version: "1.0"
   6 servers:
   7 - url: /ncmp
   8 security:
   9 - basicAuth: []
  10 paths:
  11   /v1/ch/{cm-handle}/data/ds/{datastore-name}:
  12     get:
  13       tags:
  14       - network-cm-proxy
  15       summary: Get resource data for cm handle
  16       description: Get resource data for given cm handle
  17       operationId: getResourceDataForCmHandle
  18       parameters:
  19       - name: datastore-name
  20         in: path
  21         description: The type of the requested data
  22         required: true
  23         schema:
  24           type: string
  25           example: ncmp-datastore:running
  26       - name: cm-handle
  27         in: path
  28         description: "The identifier for a network function, network element, subnetwork\
  29           \ or any other cm object by managed Network CM Proxy"
  30         required: true
  31         schema:
  32           type: string
  33           example: my-cm-handle
  34       - name: resourceIdentifier
  35         in: query
  36         description: The format of resource identifier depend on the associated DMI
  37           Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
  38           it can really be anything.
  39         required: true
  40         allowReserved: true
  41         schema:
  42           type: string
  43         examples:
  44           sample 1:
  45             value:
  46               resourceIdentifier: \shops\bookstore
  47           sample 2:
  48             value:
  49               resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
  50           sample 3:
  51             value:
  52               resourceIdentifier: "parent=shops,child=bookstore"
  53       - name: options
  54         in: query
  55         description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
  56           \ in parenthesis'()'. The format of options parameter depend on the associated\
  57           \ DMI Plugin implementation."
  58         required: false
  59         allowReserved: true
  60         schema:
  61           type: string
  62         examples:
  63           sample 1:
  64             value:
  65               options: (depth=3)
  66           sample 2:
  67             value:
  68               options: (fields=book)
  69           sample 3:
  70             value:
  71               options: "(depth=2,fields=book/authors)"
  72       - name: topic
  73         in: query
  74         description: topic parameter in query.
  75         required: false
  76         allowReserved: true
  77         schema:
  78           type: string
  79         examples:
  80           sample 1:
  81             value:
  82               topic: my-topic-name
  83       - name: include-descendants
  84         in: query
  85         description: Determines if descendants are included in response
  86         required: false
  87         schema:
  88           type: boolean
  89           default: false
  90       responses:
  91         "200":
  92           description: OK
  93           content:
  94             application/json:
  95               schema:
  96                 type: object
  97               examples:
  98                 dataSampleResponse:
  99                   $ref: '#/components/examples/dataSampleResponse'
 100         "400":
 101           description: Bad Request
 102           content:
 103             application/json:
 104               schema:
 105                 $ref: '#/components/schemas/ErrorMessage'
 106               example:
 107                 status: 400 BAD_REQUEST
 108                 message: Bad request error message
 109                 details: Bad request error details
 110         "401":
 111           description: Unauthorized
 112           content:
 113             application/json:
 114               schema:
 115                 $ref: '#/components/schemas/ErrorMessage'
 116               example:
 117                 status: 401
 118                 message: Unauthorized error message
 119                 details: Unauthorized error details
 120         "403":
 121           description: Forbidden
 122           content:
 123             application/json:
 124               schema:
 125                 $ref: '#/components/schemas/ErrorMessage'
 126               example:
 127                 status: 403
 128                 message: Forbidden error message
 129                 details: Forbidden error details
 130         "500":
 131           description: Internal Server Error
 132           content:
 133             application/json:
 134               schema:
 135                 $ref: '#/components/schemas/ErrorMessage'
 136               example:
 137                 status: 500
 138                 message: Internal Server Error
 139                 details: Internal Server Error occurred
 140         "502":
 141           description: Bad Gateway
 142           content:
 143             application/json:
 144               schema:
 145                 $ref: '#/components/schemas/DmiErrorMessage'
 146               example:
 147                 message: Bad Gateway Error Message NCMP
 148                 dmi-response:
 149                   http-code: 400
 150                   body: Bad Request
 151     put:
 152       tags:
 153       - network-cm-proxy
 154       summary: Update resource data from pass-through running for a cm handle
 155       description: Update resource data from pass-through running for the given cm
 156         handle
 157       operationId: updateResourceDataRunningForCmHandle
 158       parameters:
 159       - name: datastore-name
 160         in: path
 161         description: The type of the requested data
 162         required: true
 163         schema:
 164           type: string
 165           example: ncmp-datastore:running
 166       - name: cm-handle
 167         in: path
 168         description: "The identifier for a network function, network element, subnetwork\
 169           \ or any other cm object by managed Network CM Proxy"
 170         required: true
 171         schema:
 172           type: string
 173           example: my-cm-handle
 174       - name: resourceIdentifier
 175         in: query
 176         description: The format of resource identifier depend on the associated DMI
 177           Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
 178           it can really be anything.
 179         required: true
 180         allowReserved: true
 181         schema:
 182           type: string
 183         examples:
 184           sample 1:
 185             value:
 186               resourceIdentifier: \shops\bookstore
 187           sample 2:
 188             value:
 189               resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
 190           sample 3:
 191             value:
 192               resourceIdentifier: "parent=shops,child=bookstore"
 193       - name: Content-Type
 194         in: header
 195         description: "Content parameter for request, if content parameter is null,\
 196           \ default value is application/json."
 197         required: false
 198         schema:
 199           type: string
 200           example: application/yang-data+json
 201           default: application/json
 202       requestBody:
 203         content:
 204           application/json:
 205             schema:
 206               type: object
 207             examples:
 208               dataSampleRequest:
 209                 $ref: '#/components/examples/dataSampleRequest'
 210           application/yang-data+json:
 211             schema:
 212               type: object
 213             examples:
 214               dataSampleRequest:
 215                 $ref: '#/components/examples/dataSampleRequest'
 216         required: true
 217       responses:
 218         "200":
 219           description: OK
 220           content:
 221             application/json:
 222               schema:
 223                 type: object
 224         "400":
 225           description: Bad Request
 226           content:
 227             application/json:
 228               schema:
 229                 $ref: '#/components/schemas/ErrorMessage'
 230               example:
 231                 status: 400 BAD_REQUEST
 232                 message: Bad request error message
 233                 details: Bad request error details
 234         "401":
 235           description: Unauthorized
 236           content:
 237             application/json:
 238               schema:
 239                 $ref: '#/components/schemas/ErrorMessage'
 240               example:
 241                 status: 401
 242                 message: Unauthorized error message
 243                 details: Unauthorized error details
 244         "403":
 245           description: Forbidden
 246           content:
 247             application/json:
 248               schema:
 249                 $ref: '#/components/schemas/ErrorMessage'
 250               example:
 251                 status: 403
 252                 message: Forbidden error message
 253                 details: Forbidden error details
 254         "500":
 255           description: Internal Server Error
 256           content:
 257             application/json:
 258               schema:
 259                 $ref: '#/components/schemas/ErrorMessage'
 260               example:
 261                 status: 500
 262                 message: Internal Server Error
 263                 details: Internal Server Error occurred
 264         "502":
 265           description: Bad Gateway
 266           content:
 267             application/json:
 268               schema:
 269                 $ref: '#/components/schemas/DmiErrorMessage'
 270               example:
 271                 message: Bad Gateway Error Message NCMP
 272                 dmi-response:
 273                   http-code: 400
 274                   body: Bad Request
 275     post:
 276       tags:
 277       - network-cm-proxy
 278       summary: create resource data from pass-through running for cm handle
 279       description: create resource data from pass-through running for given cm handle
 280       operationId: createResourceDataRunningForCmHandle
 281       parameters:
 282       - name: datastore-name
 283         in: path
 284         description: The type of the requested data
 285         required: true
 286         schema:
 287           type: string
 288           example: ncmp-datastore:running
 289       - name: cm-handle
 290         in: path
 291         description: "The identifier for a network function, network element, subnetwork\
 292           \ or any other cm object by managed Network CM Proxy"
 293         required: true
 294         schema:
 295           type: string
 296           example: my-cm-handle
 297       - name: resourceIdentifier
 298         in: query
 299         description: The format of resource identifier depend on the associated DMI
 300           Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
 301           it can really be anything.
 302         required: true
 303         allowReserved: true
 304         schema:
 305           type: string
 306         examples:
 307           sample 1:
 308             value:
 309               resourceIdentifier: \shops\bookstore
 310           sample 2:
 311             value:
 312               resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
 313           sample 3:
 314             value:
 315               resourceIdentifier: "parent=shops,child=bookstore"
 316       - name: Content-Type
 317         in: header
 318         description: "Content parameter for request, if content parameter is null,\
 319           \ default value is application/json."
 320         required: false
 321         schema:
 322           type: string
 323           example: application/yang-data+json
 324           default: application/json
 325       requestBody:
 326         content:
 327           application/json:
 328             schema:
 329               type: object
 330             examples:
 331               dataSampleRequest:
 332                 $ref: '#/components/examples/dataSampleRequest'
 333           application/yang-data+json:
 334             schema:
 335               type: object
 336             examples:
 337               dataSampleRequest:
 338                 $ref: '#/components/examples/dataSampleRequest'
 339         required: true
 340       responses:
 341         "201":
 342           description: Created
 343           content: {}
 344         "400":
 345           description: Bad Request
 346           content:
 347             application/json:
 348               schema:
 349                 $ref: '#/components/schemas/ErrorMessage'
 350               example:
 351                 status: 400 BAD_REQUEST
 352                 message: Bad request error message
 353                 details: Bad request error details
 354         "401":
 355           description: Unauthorized
 356           content:
 357             application/json:
 358               schema:
 359                 $ref: '#/components/schemas/ErrorMessage'
 360               example:
 361                 status: 401
 362                 message: Unauthorized error message
 363                 details: Unauthorized error details
 364         "403":
 365           description: Forbidden
 366           content:
 367             application/json:
 368               schema:
 369                 $ref: '#/components/schemas/ErrorMessage'
 370               example:
 371                 status: 403
 372                 message: Forbidden error message
 373                 details: Forbidden error details
 374         "500":
 375           description: Internal Server Error
 376           content:
 377             application/json:
 378               schema:
 379                 $ref: '#/components/schemas/ErrorMessage'
 380               example:
 381                 status: 500
 382                 message: Internal Server Error
 383                 details: Internal Server Error occurred
 384         "502":
 385           description: Bad Gateway
 386           content:
 387             application/json:
 388               schema:
 389                 $ref: '#/components/schemas/DmiErrorMessage'
 390               example:
 391                 message: Bad Gateway Error Message NCMP
 392                 dmi-response:
 393                   http-code: 400
 394                   body: Bad Request
 395     delete:
 396       tags:
 397       - network-cm-proxy
 398       summary: Delete resource data
 399       description: Delete resource data from pass-through running for a given cm handle
 400       operationId: deleteResourceDataRunningForCmHandle
 401       parameters:
 402       - name: datastore-name
 403         in: path
 404         description: The type of the requested data
 405         required: true
 406         schema:
 407           type: string
 408           example: ncmp-datastore:running
 409       - name: cm-handle
 410         in: path
 411         description: "The identifier for a network function, network element, subnetwork\
 412           \ or any other cm object by managed Network CM Proxy"
 413         required: true
 414         schema:
 415           type: string
 416           example: my-cm-handle
 417       - name: resourceIdentifier
 418         in: query
 419         description: The format of resource identifier depend on the associated DMI
 420           Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
 421           it can really be anything.
 422         required: true
 423         allowReserved: true
 424         schema:
 425           type: string
 426         examples:
 427           sample 1:
 428             value:
 429               resourceIdentifier: \shops\bookstore
 430           sample 2:
 431             value:
 432               resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
 433           sample 3:
 434             value:
 435               resourceIdentifier: "parent=shops,child=bookstore"
 436       - name: Content-Type
 437         in: header
 438         description: "Content parameter for request, if content parameter is null,\
 439           \ default value is application/json."
 440         required: false
 441         schema:
 442           type: string
 443           example: application/yang-data+json
 444           default: application/json
 445       responses:
 446         "204":
 447           description: No Content
 448           content: {}
 449         "400":
 450           description: Bad Request
 451           content:
 452             application/json:
 453               schema:
 454                 $ref: '#/components/schemas/ErrorMessage'
 455               example:
 456                 status: 400 BAD_REQUEST
 457                 message: Bad request error message
 458                 details: Bad request error details
 459         "401":
 460           description: Unauthorized
 461           content:
 462             application/json:
 463               schema:
 464                 $ref: '#/components/schemas/ErrorMessage'
 465               example:
 466                 status: 401
 467                 message: Unauthorized error message
 468                 details: Unauthorized error details
 469         "403":
 470           description: Forbidden
 471           content:
 472             application/json:
 473               schema:
 474                 $ref: '#/components/schemas/ErrorMessage'
 475               example:
 476                 status: 403
 477                 message: Forbidden error message
 478                 details: Forbidden error details
 479         "404":
 480           description: The specified resource was not found
 481           content:
 482             application/json:
 483               schema:
 484                 $ref: '#/components/schemas/ErrorMessage'
 485               example:
 486                 status: 400
 487                 message: Not found error message
 488                 details: Not found error details
 489         "500":
 490           description: Internal Server Error
 491           content:
 492             application/json:
 493               schema:
 494                 $ref: '#/components/schemas/ErrorMessage'
 495               example:
 496                 status: 500
 497                 message: Internal Server Error
 498                 details: Internal Server Error occurred
 499         "502":
 500           description: Bad Gateway
 501           content:
 502             application/json:
 503               schema:
 504                 $ref: '#/components/schemas/DmiErrorMessage'
 505               example:
 506                 message: Bad Gateway Error Message NCMP
 507                 dmi-response:
 508                   http-code: 400
 509                   body: Bad Request
 510     patch:
 511       tags:
 512       - network-cm-proxy
 513       summary: Patch resource data from pass-through running
 514       description: Patch resource data from pass-through running for the given cm
 515         handle
 516       operationId: patchResourceDataRunningForCmHandle
 517       parameters:
 518       - name: datastore-name
 519         in: path
 520         description: The type of the requested data
 521         required: true
 522         schema:
 523           type: string
 524           example: ncmp-datastore:running
 525       - name: cm-handle
 526         in: path
 527         description: "The identifier for a network function, network element, subnetwork\
 528           \ or any other cm object by managed Network CM Proxy"
 529         required: true
 530         schema:
 531           type: string
 532           example: my-cm-handle
 533       - name: resourceIdentifier
 534         in: query
 535         description: The format of resource identifier depend on the associated DMI
 536           Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
 537           it can really be anything.
 538         required: true
 539         allowReserved: true
 540         schema:
 541           type: string
 542         examples:
 543           sample 1:
 544             value:
 545               resourceIdentifier: \shops\bookstore
 546           sample 2:
 547             value:
 548               resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
 549           sample 3:
 550             value:
 551               resourceIdentifier: "parent=shops,child=bookstore"
 552       - name: Content-Type
 553         in: header
 554         description: "Content parameter for request, if content parameter is null,\
 555           \ default value is application/json."
 556         required: false
 557         schema:
 558           type: string
 559           example: application/yang-data+json
 560           default: application/json
 561       requestBody:
 562         content:
 563           '*/*':
 564             schema:
 565               type: object
 566             examples:
 567               dataSampleRequest:
 568                 $ref: '#/components/examples/dataSamplePatchRequest'
 569         required: true
 570       responses:
 571         "200":
 572           description: OK
 573           content:
 574             application/json:
 575               schema:
 576                 type: object
 577         "400":
 578           description: Bad Request
 579           content:
 580             application/json:
 581               schema:
 582                 $ref: '#/components/schemas/ErrorMessage'
 583               example:
 584                 status: 400 BAD_REQUEST
 585                 message: Bad request error message
 586                 details: Bad request error details
 587         "401":
 588           description: Unauthorized
 589           content:
 590             application/json:
 591               schema:
 592                 $ref: '#/components/schemas/ErrorMessage'
 593               example:
 594                 status: 401
 595                 message: Unauthorized error message
 596                 details: Unauthorized error details
 597         "403":
 598           description: Forbidden
 599           content:
 600             application/json:
 601               schema:
 602                 $ref: '#/components/schemas/ErrorMessage'
 603               example:
 604                 status: 403
 605                 message: Forbidden error message
 606                 details: Forbidden error details
 607         "500":
 608           description: Internal Server Error
 609           content:
 610             application/json:
 611               schema:
 612                 $ref: '#/components/schemas/ErrorMessage'
 613               example:
 614                 status: 500
 615                 message: Internal Server Error
 616                 details: Internal Server Error occurred
 617         "502":
 618           description: Bad Gateway
 619           content:
 620             application/json:
 621               schema:
 622                 $ref: '#/components/schemas/DmiErrorMessage'
 623               example:
 624                 message: Bad Gateway Error Message NCMP
 625                 dmi-response:
 626                   http-code: 400
 627                   body: Bad Request
 628   /v1/batch/data/ds/{datastore-name}:
 629     post:
 630       tags:
 631       - network-cm-proxy
 632       summary: Get resource data for batch of cm handle ids
 633       description: This request will be handled asynchronously using messaging to
 634         the supplied topic. The rest response will be an acknowledge with a requestId
 635         to identify the relevant messages.
 636       operationId: getResourceDataForCmHandleBatch
 637       parameters:
 638       - name: datastore-name
 639         in: path
 640         description: The type of the requested data
 641         required: true
 642         schema:
 643           type: string
 644           example: ncmp-datastore:running
 645       - name: resourceIdentifier
 646         in: query
 647         description: The format of resource identifier depend on the associated DMI
 648           Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
 649           it can really be anything.
 650         required: true
 651         allowReserved: true
 652         schema:
 653           type: string
 654         examples:
 655           sample 1:
 656             value:
 657               resourceIdentifier: \shops\bookstore
 658           sample 2:
 659             value:
 660               resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
 661           sample 3:
 662             value:
 663               resourceIdentifier: "parent=shops,child=bookstore"
 664       - name: options
 665         in: query
 666         description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
 667           \ in parenthesis'()'. The format of options parameter depend on the associated\
 668           \ DMI Plugin implementation."
 669         required: false
 670         allowReserved: true
 671         schema:
 672           type: string
 673         examples:
 674           sample 1:
 675             value:
 676               options: (depth=3)
 677           sample 2:
 678             value:
 679               options: (fields=book)
 680           sample 3:
 681             value:
 682               options: "(depth=2,fields=book/authors)"
 683       - name: topic
 684         in: query
 685         description: mandatory topic parameter in query.
 686         required: true
 687         allowReserved: true
 688         schema:
 689           type: string
 690         examples:
 691           sample 1:
 692             value:
 693               topic: my-topic-name
 694       - name: include-descendants
 695         in: query
 696         description: Determines if descendants are included in response
 697         required: false
 698         schema:
 699           type: boolean
 700           default: false
 701       requestBody:
 702         content:
 703           application/json:
 704             schema:
 705               type: object
 706         required: true
 707       responses:
 708         "200":
 709           description: OK
 710           content:
 711             application/json:
 712               schema:
 713                 type: object
 714         "400":
 715           description: Bad Request
 716           content:
 717             application/json:
 718               schema:
 719                 $ref: '#/components/schemas/ErrorMessage'
 720               example:
 721                 status: 400 BAD_REQUEST
 722                 message: Bad request error message
 723                 details: Bad request error details
 724         "401":
 725           description: Unauthorized
 726           content:
 727             application/json:
 728               schema:
 729                 $ref: '#/components/schemas/ErrorMessage'
 730               example:
 731                 status: 401
 732                 message: Unauthorized error message
 733                 details: Unauthorized error details
 734         "403":
 735           description: Forbidden
 736           content:
 737             application/json:
 738               schema:
 739                 $ref: '#/components/schemas/ErrorMessage'
 740               example:
 741                 status: 403
 742                 message: Forbidden error message
 743                 details: Forbidden error details
 744         "500":
 745           description: Internal Server Error
 746           content:
 747             application/json:
 748               schema:
 749                 $ref: '#/components/schemas/ErrorMessage'
 750               example:
 751                 status: 500
 752                 message: Internal Server Error
 753                 details: Internal Server Error occurred
 754         "502":
 755           description: Bad Gateway
 756           content:
 757             application/json:
 758               schema:
 759                 $ref: '#/components/schemas/DmiErrorMessage'
 760               example:
 761                 message: Bad Gateway Error Message NCMP
 762                 dmi-response:
 763                   http-code: 400
 764                   body: Bad Request
 765   /v1/ch/{cm-handle}/data/ds/{datastore-name}/query:
 766     get:
 767       tags:
 768       - network-cm-proxy
 769       summary: Query resource data for a given cm handle
 770       description: Query resource data for a given cm handle
 771       operationId: queryResourceDataForCmHandle
 772       parameters:
 773       - name: datastore-name
 774         in: path
 775         description: The type of the requested data
 776         required: true
 777         schema:
 778           type: string
 779           example: ncmp-datastore:running
 780       - name: cm-handle
 781         in: path
 782         description: "The identifier for a network function, network element, subnetwork\
 783           \ or any other cm object by managed Network CM Proxy"
 784         required: true
 785         schema:
 786           type: string
 787           example: my-cm-handle
 788       - name: cps-path
 789         in: query
 790         description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
 791         required: false
 792         schema:
 793           type: string
 794           default: /
 795         examples:
 796           container cps path:
 797             value: //bookstore
 798           list attributes cps path:
 799             value: "//categories[@code=1]"
 800       - name: options
 801         in: query
 802         description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
 803           \ in parenthesis'()'. The format of options parameter depend on the associated\
 804           \ DMI Plugin implementation."
 805         required: false
 806         allowReserved: true
 807         schema:
 808           type: string
 809         examples:
 810           sample 1:
 811             value:
 812               options: (depth=3)
 813           sample 2:
 814             value:
 815               options: (fields=book)
 816           sample 3:
 817             value:
 818               options: "(depth=2,fields=book/authors)"
 819       - name: topic
 820         in: query
 821         description: topic parameter in query.
 822         required: false
 823         allowReserved: true
 824         schema:
 825           type: string
 826         examples:
 827           sample 1:
 828             value:
 829               topic: my-topic-name
 830       - name: include-descendants
 831         in: query
 832         description: Determines if descendants are included in response
 833         required: false
 834         schema:
 835           type: boolean
 836           default: false
 837       responses:
 838         "200":
 839           description: OK
 840           content:
 841             application/json:
 842               schema:
 843                 type: object
 844               examples:
 845                 dataSampleResponse:
 846                   $ref: '#/components/examples/dataSampleResponse'
 847         "400":
 848           description: Bad Request
 849           content:
 850             application/json:
 851               schema:
 852                 $ref: '#/components/schemas/ErrorMessage'
 853               example:
 854                 status: 400 BAD_REQUEST
 855                 message: Bad request error message
 856                 details: Bad request error details
 857         "401":
 858           description: Unauthorized
 859           content:
 860             application/json:
 861               schema:
 862                 $ref: '#/components/schemas/ErrorMessage'
 863               example:
 864                 status: 401
 865                 message: Unauthorized error message
 866                 details: Unauthorized error details
 867         "403":
 868           description: Forbidden
 869           content:
 870             application/json:
 871               schema:
 872                 $ref: '#/components/schemas/ErrorMessage'
 873               example:
 874                 status: 403
 875                 message: Forbidden error message
 876                 details: Forbidden error details
 877         "500":
 878           description: Internal Server Error
 879           content:
 880             application/json:
 881               schema:
 882                 $ref: '#/components/schemas/ErrorMessage'
 883               example:
 884                 status: 500
 885                 message: Internal Server Error
 886                 details: Internal Server Error occurred
 887         "502":
 888           description: Bad Gateway
 889           content:
 890             application/json:
 891               schema:
 892                 $ref: '#/components/schemas/DmiErrorMessage'
 893               example:
 894                 message: Bad Gateway Error Message NCMP
 895                 dmi-response:
 896                   http-code: 400
 897                   body: Bad Request
 898   /v1/ch/{cm-handle}/modules:
 899     get:
 900       tags:
 901       - network-cm-proxy
 902       summary: Fetch all module references (name and revision) for a given cm handle
 903       description: fetch all module references (name and revision) for a given cm
 904         handle
 905       operationId: getModuleReferencesByCmHandle
 906       parameters:
 907       - name: cm-handle
 908         in: path
 909         description: "The identifier for a network function, network element, subnetwork\
 910           \ or any other cm object by managed Network CM Proxy"
 911         required: true
 912         schema:
 913           type: string
 914           example: my-cm-handle
 915       responses:
 916         "200":
 917           description: OK
 918           content:
 919             application/json:
 920               schema:
 921                 type: array
 922                 items:
 923                   $ref: '#/components/schemas/RestModuleReference'
 924         "400":
 925           description: Bad Request
 926           content:
 927             application/json:
 928               schema:
 929                 $ref: '#/components/schemas/ErrorMessage'
 930               example:
 931                 status: 400 BAD_REQUEST
 932                 message: Bad request error message
 933                 details: Bad request error details
 934         "401":
 935           description: Unauthorized
 936           content:
 937             application/json:
 938               schema:
 939                 $ref: '#/components/schemas/ErrorMessage'
 940               example:
 941                 status: 401
 942                 message: Unauthorized error message
 943                 details: Unauthorized error details
 944         "403":
 945           description: Forbidden
 946           content:
 947             application/json:
 948               schema:
 949                 $ref: '#/components/schemas/ErrorMessage'
 950               example:
 951                 status: 403
 952                 message: Forbidden error message
 953                 details: Forbidden error details
 954         "500":
 955           description: Internal Server Error
 956           content:
 957             application/json:
 958               schema:
 959                 $ref: '#/components/schemas/ErrorMessage'
 960               example:
 961                 status: 500
 962                 message: Internal Server Error
 963                 details: Internal Server Error occurred
 964   /v1/ch/{cm-handle}/modules/definitions:
 965     get:
 966       tags:
 967       - network-cm-proxy
 968       summary: "Fetch all module definitions (name, revision, yang resource) for a\
 969         \ given cm handle"
 970       description: "Fetch all module definitions (name, revision, yang resource) for\
 971         \ a given cm handle"
 972       operationId: getModuleDefinitionsByCmHandleId
 973       parameters:
 974       - name: cm-handle
 975         in: path
 976         description: "The identifier for a network function, network element, subnetwork\
 977           \ or any other cm object by managed Network CM Proxy"
 978         required: true
 979         schema:
 980           type: string
 981           example: my-cm-handle
 982       responses:
 983         "200":
 984           description: OK
 985           content:
 986             application/json:
 987               schema:
 988                 type: array
 989                 items:
 990                   $ref: '#/components/schemas/RestModuleDefinition'
 991         "401":
 992           description: Unauthorized
 993           content:
 994             application/json:
 995               schema:
 996                 $ref: '#/components/schemas/ErrorMessage'
 997               example:
 998                 status: 401
 999                 message: Unauthorized error message
1000                 details: Unauthorized error details
1001         "403":
1002           description: Forbidden
1003           content:
1004             application/json:
1005               schema:
1006                 $ref: '#/components/schemas/ErrorMessage'
1007               example:
1008                 status: 403
1009                 message: Forbidden error message
1010                 details: Forbidden error details
1011         "500":
1012           description: Internal Server Error
1013           content:
1014             application/json:
1015               schema:
1016                 $ref: '#/components/schemas/ErrorMessage'
1017               example:
1018                 status: 500
1019                 message: Internal Server Error
1020                 details: Internal Server Error occurred
1021   /v1/ch/searches:
1022     post:
1023       tags:
1024       - network-cm-proxy
1025       summary: Execute cm handle search using the available conditions
1026       description: Execute cm handle query search and return a list of cm handle details.
1027         Any number of conditions can be applied. To be included in the result a cm-handle
1028         must fulfill ALL the conditions. An empty collection will be returned in the
1029         case that the cm handle does not match a condition. For more on cm handle
1030         query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm
1031         handle query search Read the Docs</a>.<br/>By supplying a CPS Path it is possible
1032         to query on any data related to the cm handle. For more on CPS Path please
1033         refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html">CPS
1034         Path Read the Docs</a>. The cm handle ancestor is automatically returned for
1035         this query.
1036       operationId: searchCmHandles
1037       requestBody:
1038         content:
1039           application/json:
1040             schema:
1041               $ref: '#/components/schemas/CmHandleQueryParameters'
1042             examples:
1043               Cm handle properties query:
1044                 $ref: '#/components/examples/pubPropCmHandleQueryParameters'
1045               Cm handle modules query:
1046                 $ref: '#/components/examples/modulesCmHandleQueryParameters'
1047               All cm handle query parameters:
1048                 $ref: '#/components/examples/allCmHandleQueryParameters'
1049               Cm handle with CPS path state query:
1050                 $ref: '#/components/examples/cpsPathCmHandleStateQueryParameters'
1051               Cm handle with data sync flag query:
1052                 $ref: '#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
1053         required: true
1054       responses:
1055         "200":
1056           description: OK
1057           content:
1058             application/json:
1059               schema:
1060                 type: array
1061                 items:
1062                   $ref: '#/components/schemas/RestOutputCmHandle'
1063         "400":
1064           description: Bad Request
1065           content:
1066             application/json:
1067               schema:
1068                 $ref: '#/components/schemas/ErrorMessage'
1069               example:
1070                 status: 400 BAD_REQUEST
1071                 message: Bad request error message
1072                 details: Bad request error details
1073         "401":
1074           description: Unauthorized
1075           content:
1076             application/json:
1077               schema:
1078                 $ref: '#/components/schemas/ErrorMessage'
1079               example:
1080                 status: 401
1081                 message: Unauthorized error message
1082                 details: Unauthorized error details
1083         "403":
1084           description: Forbidden
1085           content:
1086             application/json:
1087               schema:
1088                 $ref: '#/components/schemas/ErrorMessage'
1089               example:
1090                 status: 403
1091                 message: Forbidden error message
1092                 details: Forbidden error details
1093         "500":
1094           description: Internal Server Error
1095           content:
1096             application/json:
1097               schema:
1098                 $ref: '#/components/schemas/ErrorMessage'
1099               example:
1100                 status: 500
1101                 message: Internal Server Error
1102                 details: Internal Server Error occurred
1103   /v1/ch/{cm-handle}:
1104     get:
1105       tags:
1106       - network-cm-proxy
1107       summary: Retrieve CM handle details
1108       description: Retrieve CM handle details and properties by cm handle id
1109       operationId: retrieveCmHandleDetailsById
1110       parameters:
1111       - name: cm-handle
1112         in: path
1113         description: "The identifier for a network function, network element, subnetwork\
1114           \ or any other cm object by managed Network CM Proxy"
1115         required: true
1116         schema:
1117           type: string
1118           example: my-cm-handle
1119       responses:
1120         "200":
1121           description: OK
1122           content:
1123             application/json:
1124               schema:
1125                 $ref: '#/components/schemas/RestOutputCmHandle'
1126         "400":
1127           description: Bad Request
1128           content:
1129             application/json:
1130               schema:
1131                 $ref: '#/components/schemas/ErrorMessage'
1132               example:
1133                 status: 400 BAD_REQUEST
1134                 message: Bad request error message
1135                 details: Bad request error details
1136         "401":
1137           description: Unauthorized
1138           content:
1139             application/json:
1140               schema:
1141                 $ref: '#/components/schemas/ErrorMessage'
1142               example:
1143                 status: 401
1144                 message: Unauthorized error message
1145                 details: Unauthorized error details
1146         "404":
1147           description: The specified resource was not found
1148           content:
1149             application/json:
1150               schema:
1151                 $ref: '#/components/schemas/ErrorMessage'
1152               example:
1153                 status: 400
1154                 message: Not found error message
1155                 details: Not found error details
1156         "500":
1157           description: Internal Server Error
1158           content:
1159             application/json:
1160               schema:
1161                 $ref: '#/components/schemas/ErrorMessage'
1162               example:
1163                 status: 500
1164                 message: Internal Server Error
1165                 details: Internal Server Error occurred
1166   /v1/ch/{cm-handle}/properties:
1167     get:
1168       tags:
1169       - network-cm-proxy
1170       summary: Get CM handle properties
1171       description: Get CM handle properties by cm handle id
1172       operationId: getCmHandlePublicPropertiesByCmHandleId
1173       parameters:
1174       - name: cm-handle
1175         in: path
1176         description: "The identifier for a network function, network element, subnetwork\
1177           \ or any other cm object by managed Network CM Proxy"
1178         required: true
1179         schema:
1180           type: string
1181           example: my-cm-handle
1182       responses:
1183         "200":
1184           description: OK
1185           content:
1186             application/json:
1187               schema:
1188                 $ref: '#/components/schemas/RestOutputCmHandlePublicProperties'
1189         "400":
1190           description: Bad Request
1191           content:
1192             application/json:
1193               schema:
1194                 $ref: '#/components/schemas/ErrorMessage'
1195               example:
1196                 status: 400 BAD_REQUEST
1197                 message: Bad request error message
1198                 details: Bad request error details
1199         "401":
1200           description: Unauthorized
1201           content:
1202             application/json:
1203               schema:
1204                 $ref: '#/components/schemas/ErrorMessage'
1205               example:
1206                 status: 401
1207                 message: Unauthorized error message
1208                 details: Unauthorized error details
1209         "404":
1210           description: The specified resource was not found
1211           content:
1212             application/json:
1213               schema:
1214                 $ref: '#/components/schemas/ErrorMessage'
1215               example:
1216                 status: 400
1217                 message: Not found error message
1218                 details: Not found error details
1219         "500":
1220           description: Internal Server Error
1221           content:
1222             application/json:
1223               schema:
1224                 $ref: '#/components/schemas/ErrorMessage'
1225               example:
1226                 status: 500
1227                 message: Internal Server Error
1228                 details: Internal Server Error occurred
1229   /v1/ch/id-searches:
1230     post:
1231       tags:
1232       - network-cm-proxy
1233       summary: Execute cm handle query upon a given set of query parameters
1234       description: Execute cm handle query search and return a list of cm handle ids.
1235         Any number of conditions can be applied. To be included in the result a cm-handle
1236         must fulfill ALL the conditions. An empty collection will be returned in the
1237         case that the cm handle does not match a condition. For more on cm handle
1238         query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm
1239         handle query search Read the Docs</a>.<br/>By supplying a CPS Path it is possible
1240         to query on any data related to the cm handle. For more on CPS Path please
1241         refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html">CPS
1242         Path Read the Docs</a>. The cm handle ancestor is automatically returned for
1243         this query.
1244       operationId: searchCmHandleIds
1245       requestBody:
1246         content:
1247           application/json:
1248             schema:
1249               $ref: '#/components/schemas/CmHandleQueryParameters'
1250             examples:
1251               Cm handle properties query:
1252                 $ref: '#/components/examples/pubPropCmHandleQueryParameters'
1253               Cm handle modules query:
1254                 $ref: '#/components/examples/modulesCmHandleQueryParameters'
1255               All cm handle query parameters:
1256                 $ref: '#/components/examples/allCmHandleQueryParameters'
1257               Cm handle with CPS path state query:
1258                 $ref: '#/components/examples/cpsPathCmHandleStateQueryParameters'
1259               Cm handle with data sync flag query:
1260                 $ref: '#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
1261         required: true
1262       responses:
1263         "200":
1264           description: OK
1265           content:
1266             application/json:
1267               schema:
1268                 type: array
1269                 items:
1270                   type: string
1271         "400":
1272           description: Bad Request
1273           content:
1274             application/json:
1275               schema:
1276                 $ref: '#/components/schemas/ErrorMessage'
1277               example:
1278                 status: 400 BAD_REQUEST
1279                 message: Bad request error message
1280                 details: Bad request error details
1281         "401":
1282           description: Unauthorized
1283           content:
1284             application/json:
1285               schema:
1286                 $ref: '#/components/schemas/ErrorMessage'
1287               example:
1288                 status: 401
1289                 message: Unauthorized error message
1290                 details: Unauthorized error details
1291         "403":
1292           description: Forbidden
1293           content:
1294             application/json:
1295               schema:
1296                 $ref: '#/components/schemas/ErrorMessage'
1297               example:
1298                 status: 403
1299                 message: Forbidden error message
1300                 details: Forbidden error details
1301         "404":
1302           description: The specified resource was not found
1303           content:
1304             application/json:
1305               schema:
1306                 $ref: '#/components/schemas/ErrorMessage'
1307               example:
1308                 status: 400
1309                 message: Not found error message
1310                 details: Not found error details
1311         "500":
1312           description: Internal Server Error
1313           content:
1314             application/json:
1315               schema:
1316                 $ref: '#/components/schemas/ErrorMessage'
1317               example:
1318                 status: 500
1319                 message: Internal Server Error
1320                 details: Internal Server Error occurred
1321   /v1/ch/{cm-handle}/state:
1322     get:
1323       tags:
1324       - network-cm-proxy
1325       summary: Get CM handle state
1326       description: Get CM handle state by cm handle id
1327       operationId: getCmHandleStateByCmHandleId
1328       parameters:
1329       - name: cm-handle
1330         in: path
1331         description: "The identifier for a network function, network element, subnetwork\
1332           \ or any other cm object by managed Network CM Proxy"
1333         required: true
1334         schema:
1335           type: string
1336           example: my-cm-handle
1337       responses:
1338         "200":
1339           description: OK
1340           content:
1341             application/json:
1342               schema:
1343                 $ref: '#/components/schemas/RestOutputCmHandleCompositeState'
1344         "400":
1345           description: Bad Request
1346           content:
1347             application/json:
1348               schema:
1349                 $ref: '#/components/schemas/ErrorMessage'
1350               example:
1351                 status: 400 BAD_REQUEST
1352                 message: Bad request error message
1353                 details: Bad request error details
1354         "401":
1355           description: Unauthorized
1356           content:
1357             application/json:
1358               schema:
1359                 $ref: '#/components/schemas/ErrorMessage'
1360               example:
1361                 status: 401
1362                 message: Unauthorized error message
1363                 details: Unauthorized error details
1364         "404":
1365           description: The specified resource was not found
1366           content:
1367             application/json:
1368               schema:
1369                 $ref: '#/components/schemas/ErrorMessage'
1370               example:
1371                 status: 400
1372                 message: Not found error message
1373                 details: Not found error details
1374         "500":
1375           description: Internal Server Error
1376           content:
1377             application/json:
1378               schema:
1379                 $ref: '#/components/schemas/ErrorMessage'
1380               example:
1381                 status: 500
1382                 message: Internal Server Error
1383                 details: Internal Server Error occurred
1384   /v1/ch/{cm-handle}/data-sync:
1385     put:
1386       tags:
1387       - network-cm-proxy
1388       summary: Set the Data Sync Enabled Flag
1389       description: Set the data sync enabled flag to true or false for a specified
1390         Cm-Handle. This will in turn set the data sync state to UNSYNCHRONIZED and
1391         NONE_REQUESTED respectfully.
1392       operationId: setDataSyncEnabledFlagForCmHandle
1393       parameters:
1394       - name: cm-handle
1395         in: path
1396         description: "The identifier for a network function, network element, subnetwork\
1397           \ or any other cm object by managed Network CM Proxy"
1398         required: true
1399         schema:
1400           type: string
1401           example: my-cm-handle
1402       - name: dataSyncEnabled
1403         in: query
1404         description: Is used to enable or disable the data synchronization flag
1405         required: true
1406         schema:
1407           type: boolean
1408           example: true
1409       responses:
1410         "200":
1411           description: OK
1412           content:
1413             application/json:
1414               schema:
1415                 type: object
1416         "400":
1417           description: Bad Request
1418           content:
1419             application/json:
1420               schema:
1421                 $ref: '#/components/schemas/ErrorMessage'
1422               example:
1423                 status: 400 BAD_REQUEST
1424                 message: Bad request error message
1425                 details: Bad request error details
1426         "401":
1427           description: Unauthorized
1428           content:
1429             application/json:
1430               schema:
1431                 $ref: '#/components/schemas/ErrorMessage'
1432               example:
1433                 status: 401
1434                 message: Unauthorized error message
1435                 details: Unauthorized error details
1436         "403":
1437           description: Forbidden
1438           content:
1439             application/json:
1440               schema:
1441                 $ref: '#/components/schemas/ErrorMessage'
1442               example:
1443                 status: 403
1444                 message: Forbidden error message
1445                 details: Forbidden error details
1446         "500":
1447           description: Internal Server Error
1448           content:
1449             application/json:
1450               schema:
1451                 $ref: '#/components/schemas/ErrorMessage'
1452               example:
1453                 status: 500
1454                 message: Internal Server Error
1455                 details: Internal Server Error occurred
1456         "502":
1457           description: Bad Gateway
1458           content:
1459             application/json:
1460               schema:
1461                 $ref: '#/components/schemas/DmiErrorMessage'
1462               example:
1463                 message: Bad Gateway Error Message NCMP
1464                 dmi-response:
1465                   http-code: 400
1466                   body: Bad Request
1467 components:
1468   schemas:
1469     ErrorMessage:
1470       title: Error
1471       type: object
1472       properties:
1473         status:
1474           type: string
1475         message:
1476           type: string
1477         details:
1478           type: string
1479     DmiErrorMessage:
1480       title: DMI Error Message
1481       type: object
1482       properties:
1483         message:
1484           type: string
1485           example: Bad Gateway Error Message NCMP
1486         dmi-response:
1487           $ref: '#/components/schemas/DmiErrorMessage_dmiresponse'
1488     RestModuleReference:
1489       title: Module reference details
1490       type: object
1491       properties:
1492         moduleName:
1493           type: string
1494           example: my-module-name
1495         revision:
1496           type: string
1497           example: my-module-revision
1498     RestModuleDefinition:
1499       title: Module definitions
1500       type: object
1501       properties:
1502         moduleName:
1503           type: string
1504           example: my-module-name
1505         revision:
1506           type: string
1507           example: 2020-09-15
1508         content:
1509           type: string
1510           example: |
1511             module stores {
1512               yang-version 1.1;
1513               namespace "org:onap:ccsdk:sample";
1514               prefix book-store;
1515               revision "2020-09-15" {
1516                 description
1517                 "Sample Model";
1518               }
1519             }
1520     CmHandleQueryParameters:
1521       title: Cm Handle query parameters for executing cm handle search
1522       type: object
1523       properties:
1524         cmHandleQueryParameters:
1525           type: array
1526           items:
1527             $ref: '#/components/schemas/ConditionProperties'
1528         conditions:
1529           type: array
1530           description: "not necessary, it is just for backward compatibility"
1531           deprecated: true
1532           items:
1533             $ref: '#/components/schemas/OldConditionProperties'
1534     ConditionProperties:
1535       properties:
1536         conditionName:
1537           type: string
1538         conditionParameters:
1539           type: array
1540           items:
1541             type: object
1542             additionalProperties:
1543               type: string
1544     OldConditionProperties:
1545       properties:
1546         name:
1547           type: string
1548         conditionParameters:
1549           type: array
1550           items:
1551             $ref: '#/components/schemas/ModuleNameAsJsonObject'
1552       deprecated: true
1553     ModuleNameAsJsonObject:
1554       properties:
1555         moduleName:
1556           type: string
1557           example: my-module
1558     RestOutputCmHandle:
1559       title: CM handle Details
1560       type: object
1561       properties:
1562         cmHandle:
1563           type: string
1564           example: my-cm-handle1
1565         publicCmHandleProperties:
1566           $ref: '#/components/schemas/CmHandlePublicProperties'
1567         state:
1568           $ref: '#/components/schemas/CmHandleCompositeState'
1569     CmHandlePublicProperties:
1570       type: array
1571       items:
1572         type: object
1573         additionalProperties:
1574           type: string
1575           example: Book Type
1576     CmHandleCompositeState:
1577       type: object
1578       properties:
1579         cmHandleState:
1580           type: string
1581           example: ADVISED
1582         lockReason:
1583           $ref: '#/components/schemas/lock-reason'
1584         lastUpdateTime:
1585           type: string
1586           example: 2022-12-31T20:30:40.000+0000
1587         dataSyncEnabled:
1588           type: boolean
1589           example: false
1590         dataSyncState:
1591           $ref: '#/components/schemas/dataStores'
1592     lock-reason:
1593       type: object
1594       properties:
1595         reason:
1596           type: string
1597           example: LOCKED_MISBEHAVING
1598         details:
1599           type: string
1600           example: locked due to failure in module sync
1601     dataStores:
1602       type: object
1603       properties:
1604         operational:
1605           $ref: '#/components/schemas/sync-state'
1606         running:
1607           $ref: '#/components/schemas/sync-state'
1608     sync-state:
1609       type: object
1610       properties:
1611         syncState:
1612           type: string
1613           example: NONE_REQUESTED
1614         lastSyncTime:
1615           type: string
1616           example: 2022-12-31T20:30:40.000+0000
1617     RestOutputCmHandlePublicProperties:
1618       type: object
1619       properties:
1620         publicCmHandleProperties:
1621           $ref: '#/components/schemas/CmHandlePublicProperties'
1622     RestOutputCmHandleCompositeState:
1623       type: object
1624       properties:
1625         state:
1626           $ref: '#/components/schemas/CmHandleCompositeState'
1627     DmiErrorMessage_dmiresponse:
1628       type: object
1629       properties:
1630         http-code:
1631           type: integer
1632           example: 400
1633         body:
1634           type: string
1635           example: Bad Request
1636   responses:
1637     BadRequest:
1638       description: Bad Request
1639       content:
1640         application/json:
1641           schema:
1642             $ref: '#/components/schemas/ErrorMessage'
1643           example:
1644             status: 400 BAD_REQUEST
1645             message: Bad request error message
1646             details: Bad request error details
1647     Unauthorized:
1648       description: Unauthorized
1649       content:
1650         application/json:
1651           schema:
1652             $ref: '#/components/schemas/ErrorMessage'
1653           example:
1654             status: 401
1655             message: Unauthorized error message
1656             details: Unauthorized error details
1657     Forbidden:
1658       description: Forbidden
1659       content:
1660         application/json:
1661           schema:
1662             $ref: '#/components/schemas/ErrorMessage'
1663           example:
1664             status: 403
1665             message: Forbidden error message
1666             details: Forbidden error details
1667     InternalServerError:
1668       description: Internal Server Error
1669       content:
1670         application/json:
1671           schema:
1672             $ref: '#/components/schemas/ErrorMessage'
1673           example:
1674             status: 500
1675             message: Internal Server Error
1676             details: Internal Server Error occurred
1677     BadGateway:
1678       description: Bad Gateway
1679       content:
1680         application/json:
1681           schema:
1682             $ref: '#/components/schemas/DmiErrorMessage'
1683           example:
1684             message: Bad Gateway Error Message NCMP
1685             dmi-response:
1686               http-code: 400
1687               body: Bad Request
1688     Ok:
1689       description: OK
1690       content:
1691         application/json:
1692           schema:
1693             type: object
1694     Created:
1695       description: Created
1696       content: {}
1697     NoContent:
1698       description: No Content
1699       content: {}
1700     NotFound:
1701       description: The specified resource was not found
1702       content:
1703         application/json:
1704           schema:
1705             $ref: '#/components/schemas/ErrorMessage'
1706           example:
1707             status: 400
1708             message: Not found error message
1709             details: Not found error details
1710   parameters:
1711     datastoreName:
1712       name: datastore-name
1713       in: path
1714       description: The type of the requested data
1715       required: true
1716       schema:
1717         type: string
1718         example: ncmp-datastore:running
1719     cmHandleInPath:
1720       name: cm-handle
1721       in: path
1722       description: "The identifier for a network function, network element, subnetwork\
1723         \ or any other cm object by managed Network CM Proxy"
1724       required: true
1725       schema:
1726         type: string
1727         example: my-cm-handle
1728     resourceIdentifierInQuery:
1729       name: resourceIdentifier
1730       in: query
1731       description: The format of resource identifier depend on the associated DMI
1732         Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but it
1733         can really be anything.
1734       required: true
1735       allowReserved: true
1736       schema:
1737         type: string
1738       examples:
1739         sample 1:
1740           value:
1741             resourceIdentifier: \shops\bookstore
1742         sample 2:
1743           value:
1744             resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
1745         sample 3:
1746           value:
1747             resourceIdentifier: "parent=shops,child=bookstore"
1748     optionsParamInQuery:
1749       name: options
1750       in: query
1751       description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
1752         \ in parenthesis'()'. The format of options parameter depend on the associated\
1753         \ DMI Plugin implementation."
1754       required: false
1755       allowReserved: true
1756       schema:
1757         type: string
1758       examples:
1759         sample 1:
1760           value:
1761             options: (depth=3)
1762         sample 2:
1763           value:
1764             options: (fields=book)
1765         sample 3:
1766           value:
1767             options: "(depth=2,fields=book/authors)"
1768     topicParamInQuery:
1769       name: topic
1770       in: query
1771       description: topic parameter in query.
1772       required: false
1773       allowReserved: true
1774       schema:
1775         type: string
1776       examples:
1777         sample 1:
1778           value:
1779             topic: my-topic-name
1780     includeDescendantsOptionInQuery:
1781       name: include-descendants
1782       in: query
1783       description: Determines if descendants are included in response
1784       required: false
1785       schema:
1786         type: boolean
1787         default: false
1788     contentParamInHeader:
1789       name: Content-Type
1790       in: header
1791       description: "Content parameter for request, if content parameter is null, default\
1792         \ value is application/json."
1793       required: false
1794       schema:
1795         type: string
1796         example: application/yang-data+json
1797         default: application/json
1798     requiredTopicParamInQuery:
1799       name: topic
1800       in: query
1801       description: mandatory topic parameter in query.
1802       required: true
1803       allowReserved: true
1804       schema:
1805         type: string
1806       examples:
1807         sample 1:
1808           value:
1809             topic: my-topic-name
1810     cpsPathInQuery:
1811       name: cps-path
1812       in: query
1813       description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1814       required: false
1815       schema:
1816         type: string
1817         default: /
1818       examples:
1819         container cps path:
1820           value: //bookstore
1821         list attributes cps path:
1822           value: "//categories[@code=1]"
1823     dataSyncEnabled:
1824       name: dataSyncEnabled
1825       in: query
1826       description: Is used to enable or disable the data synchronization flag
1827       required: true
1828       schema:
1829         type: boolean
1830         example: true
1831   examples:
1832     dataSampleResponse:
1833       summary: Sample response
1834       description: Sample response for selecting 'sample 1'.
1835       value:
1836         bookstore:
1837           categories:
1838           - code: "01"
1839             books:
1840             - authors:
1841               - Iain M. Banks
1842               - Ursula K. Le Guin
1843             name: SciFi
1844           - code: "02"
1845             books:
1846             - authors:
1847               - Philip Pullman
1848             name: kids
1849     dataSampleRequest:
1850       summary: Sample request
1851       description: Sample request body
1852       value:
1853         test:bookstore:
1854           bookstore-name: Chapters
1855           categories:
1856           - code: "01"
1857             name: SciFi
1858             books:
1859             - authors:
1860               - Iain M. Banks
1861               - Ursula K. Le Guin
1862           - code: "02"
1863             name: kids
1864             books:
1865             - authors:
1866               - Philip Pullman
1867     dataSamplePatchRequest:
1868       summary: Sample patch request
1869       description: Sample patch request body
1870       value:
1871         ietf-restconf:yang-patch:
1872           patch-id: patch-1
1873           edit:
1874           - edit-id: edit1
1875             operation: merge
1876             target: /
1877             value:
1878               test:bookstore:
1879                 bookstore-name: Chapters
1880                 categories:
1881                 - code: "01"
1882                   name: Science
1883                   books:
1884                   - authors:
1885                     - Author1
1886                     - Author2
1887                 - code: "02"
1888                   name: Arts
1889                   books:
1890                   - authors:
1891                     - Author3
1892           - edit-id: edit2
1893             operation: merge
1894             target: /
1895             value:
1896               test:bookstore:
1897                 bookstore-name: Novels
1898                 categories:
1899                 - code: "03"
1900                   name: History
1901                   books:
1902                   - authors:
1903                     - Iain M. Banks
1904                     - Ursula K. Le Guin
1905                 - code: "04"
1906                   name: Fiction
1907                   books:
1908                   - authors:
1909                     - Philip Pullman
1910     pubPropCmHandleQueryParameters:
1911       value:
1912         cmHandleQueryParameters:
1913         - conditionName: hasAllProperties
1914           conditionParameters:
1915           - Color: yellow
1916           - Shape: circle
1917           - Size: small
1918     modulesCmHandleQueryParameters:
1919       value:
1920         cmHandleQueryParameters:
1921         - conditionName: hasAllModules
1922           conditionParameters:
1923           - moduleName: my-module-1
1924           - moduleName: my-module-2
1925           - moduleName: my-module-3
1926     allCmHandleQueryParameters:
1927       value:
1928         cmHandleQueryParameters:
1929         - conditionName: hasAllModules
1930           conditionParameters:
1931           - moduleName: my-module-1
1932           - moduleName: my-module-2
1933           - moduleName: my-module-3
1934         - conditionName: hasAllProperties
1935           conditionParameters:
1936           - Color: yellow
1937           - Shape: circle
1938           - Size: small
1939         - conditionName: cmHandleWithCpsPath
1940           conditionParameters:
1941           - cpsPath: "//state[@cm-handle-state='ADVISED']"
1942     cpsPathCmHandleStateQueryParameters:
1943       value:
1944         cmHandleQueryParameters:
1945         - conditionName: cmHandleWithCpsPath
1946           conditionParameters:
1947           - cpsPath: "//state[@cm-handle-state='LOCKED']"
1948     cpsPathCmHandleDataSyncQueryParameters:
1949       value:
1950         cmHandleQueryParameters:
1951         - conditionName: cmHandleWithCpsPath
1952           conditionParameters:
1953           - cpsPath: "//state[@data-sync-enabled='true']"
1954   securitySchemes:
1955     basicAuth:
1956       type: http
1957       scheme: basic