docs/api/swagger/cps/openapi.yaml

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