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   /v1/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       deprecated: true
1115       operationId: getNodeByDataspaceAndAnchor
1116       parameters:
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   /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
1203     get:
1204       tags:
1205       - cps-data
1206       summary: Get a node
1207       description: Get a node with an option to retrieve all the children for a given
1208         anchor and dataspace
1209       operationId: getNodeByDataspaceAndAnchorV2
1210       parameters:
1211       - name: dataspace-name
1212         in: path
1213         description: dataspace-name
1214         required: true
1215         schema:
1216           type: string
1217           example: my-dataspace
1218       - name: anchor-name
1219         in: path
1220         description: anchor-name
1221         required: true
1222         schema:
1223           type: string
1224           example: my-anchor
1225       - name: xpath
1226         in: query
1227         description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1228         required: false
1229         schema:
1230           type: string
1231           default: /
1232         examples:
1233           container xpath:
1234             value: /shops/bookstore
1235           list attributes xpath:
1236             value: "/shops/bookstore/categories[@code=1]"
1237       - name: descendants
1238         in: query
1239         description: descendants
1240         required: false
1241         schema:
1242           type: string
1243           example: 3
1244           default: none
1245                   pattern: '^all$|^none$|^[0-9]+$|^-1$'
1246       responses:
1247         "200":
1248           description: OK
1249           content:
1250             application/json:
1251               schema:
1252                 type: object
1253               examples:
1254                 dataSample:
1255                   $ref: '#/components/examples/dataSample'
1256         "400":
1257           description: Bad Request
1258           content:
1259             application/json:
1260               schema:
1261                 $ref: '#/components/schemas/ErrorMessage'
1262               example:
1263                 status: 400
1264                 message: Bad Request
1265                 details: The provided request is not valid
1266         "401":
1267           description: Unauthorized
1268           content:
1269             application/json:
1270               schema:
1271                 $ref: '#/components/schemas/ErrorMessage'
1272               example:
1273                 status: 401
1274                 message: Unauthorized request
1275                 details: This request is unauthorized
1276         "403":
1277           description: Forbidden
1278           content:
1279             application/json:
1280               schema:
1281                 $ref: '#/components/schemas/ErrorMessage'
1282               example:
1283                 status: 403
1284                 message: Request Forbidden
1285                 details: This request is forbidden
1286         "500":
1287           description: Internal Server Error
1288           content:
1289             application/json:
1290               schema:
1291                 $ref: '#/components/schemas/ErrorMessage'
1292               example:
1293                 status: 500
1294                 message: Internal Server Error
1295                 details: Internal Server Error occurred
1296       x-codegen-request-body-name: xpath
1297   /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
1298     put:
1299       tags:
1300       - cps-data
1301       summary: Replace a node with descendants
1302       description: "Replace a node with descendants for a given dataspace, anchor\
1303         \ and a parent node xpath"
1304       operationId: replaceNode
1305       parameters:
1306       - $ref: '#/components/parameters/apiVersionInPath'
1307       - name: dataspace-name
1308         in: path
1309         description: dataspace-name
1310         required: true
1311         schema:
1312           type: string
1313           example: my-dataspace
1314       - name: anchor-name
1315         in: path
1316         description: anchor-name
1317         required: true
1318         schema:
1319           type: string
1320           example: my-anchor
1321       - name: xpath
1322         in: query
1323         description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1324         required: false
1325         schema:
1326           type: string
1327           default: /
1328         examples:
1329           container xpath:
1330             value: /shops/bookstore
1331           list attributes xpath:
1332             value: "/shops/bookstore/categories[@code=1]"
1333       - name: observed-timestamp
1334         in: query
1335         description: observed-timestamp
1336         required: false
1337         schema:
1338           type: string
1339           example: 2021-03-21T00:10:34.030-0100
1340       requestBody:
1341         content:
1342           application/json:
1343             schema:
1344               type: object
1345             examples:
1346               dataSample:
1347                 $ref: '#/components/examples/dataSample'
1348         required: true
1349       responses:
1350         "200":
1351           description: OK
1352           content:
1353             application/json:
1354               schema:
1355                 type: object
1356               examples:
1357                 dataSample:
1358                   value: ""
1359         "400":
1360           description: Bad Request
1361           content:
1362             application/json:
1363               schema:
1364                 $ref: '#/components/schemas/ErrorMessage'
1365               example:
1366                 status: 400
1367                 message: Bad Request
1368                 details: The provided request is not valid
1369         "401":
1370           description: Unauthorized
1371           content:
1372             application/json:
1373               schema:
1374                 $ref: '#/components/schemas/ErrorMessage'
1375               example:
1376                 status: 401
1377                 message: Unauthorized request
1378                 details: This request is unauthorized
1379         "403":
1380           description: Forbidden
1381           content:
1382             application/json:
1383               schema:
1384                 $ref: '#/components/schemas/ErrorMessage'
1385               example:
1386                 status: 403
1387                 message: Request Forbidden
1388                 details: This request is forbidden
1389         "500":
1390           description: Internal Server Error
1391           content:
1392             application/json:
1393               schema:
1394                 $ref: '#/components/schemas/ErrorMessage'
1395               example:
1396                 status: 500
1397                 message: Internal Server Error
1398                 details: Internal Server Error occurred
1399     post:
1400       tags:
1401       - cps-data
1402       summary: Create a node
1403       description: Create a node for a given anchor and dataspace
1404       operationId: createNode
1405       parameters:
1406       - $ref: '#/components/parameters/apiVersionInPath'
1407       - name: dataspace-name
1408         in: path
1409         description: dataspace-name
1410         required: true
1411         schema:
1412           type: string
1413           example: my-dataspace
1414       - name: anchor-name
1415         in: path
1416         description: anchor-name
1417         required: true
1418         schema:
1419           type: string
1420           example: my-anchor
1421       - name: xpath
1422         in: query
1423         description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1424         required: false
1425         schema:
1426           type: string
1427           default: /
1428         examples:
1429           container xpath:
1430             value: /shops/bookstore
1431           list attributes xpath:
1432             value: "/shops/bookstore/categories[@code=1]"
1433       - name: observed-timestamp
1434         in: query
1435         description: observed-timestamp
1436         required: false
1437         schema:
1438           type: string
1439           example: 2021-03-21T00:10:34.030-0100
1440       requestBody:
1441         content:
1442           application/json:
1443             schema:
1444               type: object
1445             examples:
1446               dataSample:
1447                 $ref: '#/components/examples/dataSample'
1448         required: true
1449       responses:
1450         "201":
1451           description: Created
1452           content:
1453             text/plain:
1454               schema:
1455                 type: string
1456                 example: my-resource
1457         "400":
1458           description: Bad Request
1459           content:
1460             application/json:
1461               schema:
1462                 $ref: '#/components/schemas/ErrorMessage'
1463               example:
1464                 status: 400
1465                 message: Bad Request
1466                 details: The provided request is not valid
1467         "401":
1468           description: Unauthorized
1469           content:
1470             application/json:
1471               schema:
1472                 $ref: '#/components/schemas/ErrorMessage'
1473               example:
1474                 status: 401
1475                 message: Unauthorized request
1476                 details: This request is unauthorized
1477         "403":
1478           description: Forbidden
1479           content:
1480             application/json:
1481               schema:
1482                 $ref: '#/components/schemas/ErrorMessage'
1483               example:
1484                 status: 403
1485                 message: Request Forbidden
1486                 details: This request is forbidden
1487         "409":
1488           description: Conflict
1489           content:
1490             application/json:
1491               schema:
1492                 $ref: '#/components/schemas/ErrorMessage'
1493               example:
1494                 status: 409
1495                 message: Conflicting request
1496                 details: The request cannot be processed as the resource is in use.
1497         "500":
1498           description: Internal Server Error
1499           content:
1500             application/json:
1501               schema:
1502                 $ref: '#/components/schemas/ErrorMessage'
1503               example:
1504                 status: 500
1505                 message: Internal Server Error
1506                 details: Internal Server Error occurred
1507     delete:
1508       tags:
1509       - cps-data
1510       summary: Delete a data node
1511       description: Delete a datanode for a given dataspace and anchor given a node
1512         xpath.
1513       operationId: deleteDataNode
1514       parameters:
1515       - $ref: '#/components/parameters/apiVersionInPath'
1516       - name: dataspace-name
1517         in: path
1518         description: dataspace-name
1519         required: true
1520         schema:
1521           type: string
1522           example: my-dataspace
1523       - name: anchor-name
1524         in: path
1525         description: anchor-name
1526         required: true
1527         schema:
1528           type: string
1529           example: my-anchor
1530       - name: xpath
1531         in: query
1532         description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1533         required: false
1534         schema:
1535           type: string
1536           default: /
1537         examples:
1538           container xpath:
1539             value: /shops/bookstore
1540           list attributes xpath:
1541             value: "/shops/bookstore/categories[@code=1]"
1542       - name: observed-timestamp
1543         in: query
1544         description: observed-timestamp
1545         required: false
1546         schema:
1547           type: string
1548           example: 2021-03-21T00:10:34.030-0100
1549       responses:
1550         "204":
1551           description: No Content
1552           content: {}
1553         "400":
1554           description: Bad Request
1555           content:
1556             application/json:
1557               schema:
1558                 $ref: '#/components/schemas/ErrorMessage'
1559               example:
1560                 status: 400
1561                 message: Bad Request
1562                 details: The provided request is not valid
1563         "401":
1564           description: Unauthorized
1565           content:
1566             application/json:
1567               schema:
1568                 $ref: '#/components/schemas/ErrorMessage'
1569               example:
1570                 status: 401
1571                 message: Unauthorized request
1572                 details: This request is unauthorized
1573         "403":
1574           description: Forbidden
1575           content:
1576             application/json:
1577               schema:
1578                 $ref: '#/components/schemas/ErrorMessage'
1579               example:
1580                 status: 403
1581                 message: Request Forbidden
1582                 details: This request is forbidden
1583         "500":
1584           description: Internal Server Error
1585           content:
1586             application/json:
1587               schema:
1588                 $ref: '#/components/schemas/ErrorMessage'
1589               example:
1590                 status: 500
1591                 message: Internal Server Error
1592                 details: Internal Server Error occurred
1593     patch:
1594       tags:
1595       - cps-data
1596       summary: Update node leaves
1597       description: Update a data node leaves for a given dataspace and anchor and
1598         a parent node xpath
1599       operationId: updateNodeLeaves
1600       parameters:
1601       - $ref: '#/components/parameters/apiVersionInPath'
1602       - name: dataspace-name
1603         in: path
1604         description: dataspace-name
1605         required: true
1606         schema:
1607           type: string
1608           example: my-dataspace
1609       - name: anchor-name
1610         in: path
1611         description: anchor-name
1612         required: true
1613         schema:
1614           type: string
1615           example: my-anchor
1616       - name: xpath
1617         in: query
1618         description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1619         required: false
1620         schema:
1621           type: string
1622           default: /
1623         examples:
1624           container xpath:
1625             value: /shops/bookstore
1626           list attributes xpath:
1627             value: "/shops/bookstore/categories[@code=1]"
1628       - name: observed-timestamp
1629         in: query
1630         description: observed-timestamp
1631         required: false
1632         schema:
1633           type: string
1634           example: 2021-03-21T00:10:34.030-0100
1635       requestBody:
1636         content:
1637           application/json:
1638             schema:
1639               type: object
1640             examples:
1641               dataSample:
1642                 $ref: '#/components/examples/dataSample'
1643         required: true
1644       responses:
1645         "200":
1646           description: OK
1647           content:
1648             application/json:
1649               schema:
1650                 type: object
1651               examples:
1652                 dataSample:
1653                   value: ""
1654         "400":
1655           description: Bad Request
1656           content:
1657             application/json:
1658               schema:
1659                 $ref: '#/components/schemas/ErrorMessage'
1660               example:
1661                 status: 400
1662                 message: Bad Request
1663                 details: The provided request is not valid
1664         "401":
1665           description: Unauthorized
1666           content:
1667             application/json:
1668               schema:
1669                 $ref: '#/components/schemas/ErrorMessage'
1670               example:
1671                 status: 401
1672                 message: Unauthorized request
1673                 details: This request is unauthorized
1674         "403":
1675           description: Forbidden
1676           content:
1677             application/json:
1678               schema:
1679                 $ref: '#/components/schemas/ErrorMessage'
1680               example:
1681                 status: 403
1682                 message: Request Forbidden
1683                 details: This request is forbidden
1684         "500":
1685           description: Internal Server Error
1686           content:
1687             application/json:
1688               schema:
1689                 $ref: '#/components/schemas/ErrorMessage'
1690               example:
1691                 status: 500
1692                 message: Internal Server Error
1693                 details: Internal Server Error occurred
1694   /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
1695     put:
1696       tags:
1697       - cps-data
1698       summary: Replace list content
1699       description: "Replace list content under a given parent, anchor and dataspace"
1700       operationId: replaceListContent
1701       parameters:
1702       - $ref: '#/components/parameters/apiVersionInPath'
1703       - name: dataspace-name
1704         in: path
1705         description: dataspace-name
1706         required: true
1707         schema:
1708           type: string
1709           example: my-dataspace
1710       - name: anchor-name
1711         in: path
1712         description: anchor-name
1713         required: true
1714         schema:
1715           type: string
1716           example: my-anchor
1717       - name: xpath
1718         in: query
1719         description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1720         required: true
1721         schema:
1722           type: string
1723         examples:
1724           container xpath:
1725             value: /shops/bookstore
1726           list attributes xpath:
1727             value: "/shops/bookstore/categories[@code=1]"
1728       - name: observed-timestamp
1729         in: query
1730         description: observed-timestamp
1731         required: false
1732         schema:
1733           type: string
1734           example: 2021-03-21T00:10:34.030-0100
1735       requestBody:
1736         content:
1737           application/json:
1738             schema:
1739               type: object
1740             examples:
1741               dataSample:
1742                 $ref: '#/components/examples/dataSample'
1743         required: true
1744       responses:
1745         "200":
1746           description: OK
1747           content:
1748             application/json:
1749               schema:
1750                 type: object
1751               examples:
1752                 dataSample:
1753                   value: ""
1754         "400":
1755           description: Bad Request
1756           content:
1757             application/json:
1758               schema:
1759                 $ref: '#/components/schemas/ErrorMessage'
1760               example:
1761                 status: 400
1762                 message: Bad Request
1763                 details: The provided request is not valid
1764         "401":
1765           description: Unauthorized
1766           content:
1767             application/json:
1768               schema:
1769                 $ref: '#/components/schemas/ErrorMessage'
1770               example:
1771                 status: 401
1772                 message: Unauthorized request
1773                 details: This request is unauthorized
1774         "403":
1775           description: Forbidden
1776           content:
1777             application/json:
1778               schema:
1779                 $ref: '#/components/schemas/ErrorMessage'
1780               example:
1781                 status: 403
1782                 message: Request Forbidden
1783                 details: This request is forbidden
1784         "500":
1785           description: Internal Server Error
1786           content:
1787             application/json:
1788               schema:
1789                 $ref: '#/components/schemas/ErrorMessage'
1790               example:
1791                 status: 500
1792                 message: Internal Server Error
1793                 details: Internal Server Error occurred
1794     post:
1795       tags:
1796       - cps-data
1797       summary: Add list element(s)
1798       description: Add list element(s) to a list for a given anchor and dataspace
1799       operationId: addListElements
1800       parameters:
1801       - $ref: '#/components/parameters/apiVersionInPath'
1802       - name: dataspace-name
1803         in: path
1804         description: dataspace-name
1805         required: true
1806         schema:
1807           type: string
1808           example: my-dataspace
1809       - name: anchor-name
1810         in: path
1811         description: anchor-name
1812         required: true
1813         schema:
1814           type: string
1815           example: my-anchor
1816       - name: xpath
1817         in: query
1818         description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1819         required: true
1820         schema:
1821           type: string
1822         examples:
1823           container xpath:
1824             value: /shops/bookstore
1825           list attributes xpath:
1826             value: "/shops/bookstore/categories[@code=1]"
1827       - name: observed-timestamp
1828         in: query
1829         description: observed-timestamp
1830         required: false
1831         schema:
1832           type: string
1833           example: 2021-03-21T00:10:34.030-0100
1834       requestBody:
1835         content:
1836           application/json:
1837             schema:
1838               type: object
1839             examples:
1840               dataSample:
1841                 $ref: '#/components/examples/dataSample'
1842         required: true
1843       responses:
1844         "201":
1845           description: Created
1846           content:
1847             text/plain:
1848               schema:
1849                 type: string
1850                 example: my-resource
1851         "400":
1852           description: Bad Request
1853           content:
1854             application/json:
1855               schema:
1856                 $ref: '#/components/schemas/ErrorMessage'
1857               example:
1858                 status: 400
1859                 message: Bad Request
1860                 details: The provided request is not valid
1861         "401":
1862           description: Unauthorized
1863           content:
1864             application/json:
1865               schema:
1866                 $ref: '#/components/schemas/ErrorMessage'
1867               example:
1868                 status: 401
1869                 message: Unauthorized request
1870                 details: This request is unauthorized
1871         "403":
1872           description: Forbidden
1873           content:
1874             application/json:
1875               schema:
1876                 $ref: '#/components/schemas/ErrorMessage'
1877               example:
1878                 status: 403
1879                 message: Request Forbidden
1880                 details: This request is forbidden
1881         "500":
1882           description: Internal Server Error
1883           content:
1884             application/json:
1885               schema:
1886                 $ref: '#/components/schemas/ErrorMessage'
1887               example:
1888                 status: 500
1889                 message: Internal Server Error
1890                 details: Internal Server Error occurred
1891     delete:
1892       tags:
1893       - cps-data
1894       summary: Delete one or all list element(s)
1895       description: Delete one or all list element(s) for a given anchor and dataspace
1896       operationId: deleteListOrListElement
1897       parameters:
1898       - $ref: '#/components/parameters/apiVersionInPath'
1899       - name: dataspace-name
1900         in: path
1901         description: dataspace-name
1902         required: true
1903         schema:
1904           type: string
1905           example: my-dataspace
1906       - name: anchor-name
1907         in: path
1908         description: anchor-name
1909         required: true
1910         schema:
1911           type: string
1912           example: my-anchor
1913       - name: xpath
1914         in: query
1915         description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1916         required: true
1917         schema:
1918           type: string
1919         examples:
1920           container xpath:
1921             value: /shops/bookstore
1922           list attributes xpath:
1923             value: "/shops/bookstore/categories[@code=1]"
1924       - name: observed-timestamp
1925         in: query
1926         description: observed-timestamp
1927         required: false
1928         schema:
1929           type: string
1930           example: 2021-03-21T00:10:34.030-0100
1931       responses:
1932         "204":
1933           description: No Content
1934           content: {}
1935         "400":
1936           description: Bad Request
1937           content:
1938             application/json:
1939               schema:
1940                 $ref: '#/components/schemas/ErrorMessage'
1941               example:
1942                 status: 400
1943                 message: Bad Request
1944                 details: The provided request is not valid
1945         "401":
1946           description: Unauthorized
1947           content:
1948             application/json:
1949               schema:
1950                 $ref: '#/components/schemas/ErrorMessage'
1951               example:
1952                 status: 401
1953                 message: Unauthorized request
1954                 details: This request is unauthorized
1955         "403":
1956           description: Forbidden
1957           content:
1958             application/json:
1959               schema:
1960                 $ref: '#/components/schemas/ErrorMessage'
1961               example:
1962                 status: 403
1963                 message: Request Forbidden
1964                 details: This request is forbidden
1965         "500":
1966           description: Internal Server Error
1967           content:
1968             application/json:
1969               schema:
1970                 $ref: '#/components/schemas/ErrorMessage'
1971               example:
1972                 status: 500
1973                 message: Internal Server Error
1974                 details: Internal Server Error occurred
1975       deprecated: true
1976   /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
1977     get:
1978       tags:
1979       - cps-query
1980       summary: Query data nodes
1981       description: Query data nodes for the given dataspace and anchor using CPS path
1982       operationId: getNodesByDataspaceAndAnchorAndCpsPath
1983       parameters:
1984       - $ref: '#/components/parameters/apiVersionInPath'
1985       - name: dataspace-name
1986         in: path
1987         description: dataspace-name
1988         required: true
1989         schema:
1990           type: string
1991           example: my-dataspace
1992       - name: anchor-name
1993         in: path
1994         description: anchor-name
1995         required: true
1996         schema:
1997           type: string
1998           example: my-anchor
1999       - name: cps-path
2000         in: query
2001         description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2002         required: false
2003         schema:
2004           type: string
2005           default: /
2006         examples:
2007           container cps path:
2008             value: //bookstore
2009           list attributes cps path:
2010             value: "//categories[@code=1]"
2011       - name: include-descendants
2012         in: query
2013         description: include-descendants
2014         required: false
2015         schema:
2016           type: boolean
2017           example: false
2018           default: false
2019       responses:
2020         "200":
2021           description: OK
2022           content:
2023             application/json:
2024               schema:
2025                 type: object
2026               examples:
2027                 dataSample:
2028                   $ref: '#/components/examples/dataSample'
2029         "400":
2030           description: Bad Request
2031           content:
2032             application/json:
2033               schema:
2034                 $ref: '#/components/schemas/ErrorMessage'
2035               example:
2036                 status: 400
2037                 message: Bad Request
2038                 details: The provided request is not valid
2039         "401":
2040           description: Unauthorized
2041           content:
2042             application/json:
2043               schema:
2044                 $ref: '#/components/schemas/ErrorMessage'
2045               example:
2046                 status: 401
2047                 message: Unauthorized request
2048                 details: This request is unauthorized
2049         "403":
2050           description: Forbidden
2051           content:
2052             application/json:
2053               schema:
2054                 $ref: '#/components/schemas/ErrorMessage'
2055               example:
2056                 status: 403
2057                 message: Request Forbidden
2058                 details: This request is forbidden
2059         "500":
2060           description: Internal Server Error
2061           content:
2062             application/json:
2063               schema:
2064                 $ref: '#/components/schemas/ErrorMessage'
2065               example:
2066                 status: 500
2067                 message: Internal Server Error
2068                 details: Internal Server Error occurred
2069       x-codegen-request-body-name: xpath
2070   /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
2071     get:
2072       tags:
2073       - cps-query
2074       summary: Query data nodes
2075       description: Query data nodes for the given dataspace and anchor using CPS path
2076       operationId: getNodesByDataspaceAndAnchorAndCpsPathV2
2077       parameters:
2078       - name: dataspace-name
2079         in: path
2080         description: dataspace-name
2081         required: true
2082         schema:
2083           type: string
2084           example: my-dataspace
2085       - name: anchor-name
2086         in: path
2087         description: anchor-name
2088         required: true
2089         schema:
2090           type: string
2091           example: my-anchor
2092       - name: cps-path
2093         in: query
2094         description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2095         required: false
2096         schema:
2097           type: string
2098           default: /
2099         examples:
2100           container cps path:
2101             value: //bookstore
2102           list attributes cps path:
2103             value: "//categories[@code=1]"
2104       - name: descendants
2105         in: query
2106         description: descendants
2107         required: false
2108         schema:
2109           type: string
2110                   pattern: '^all$|^none$|^[0-9]+$|^-1$'
2111           example: false
2112           default: none
2113                   example: 3
2114       responses:
2115         "200":
2116           description: OK
2117           content:
2118             application/json:
2119               schema:
2120                 type: object
2121               examples:
2122                 dataSample:
2123                   $ref: '#/components/examples/dataSample'
2124         "400":
2125           description: Bad Request
2126           content:
2127             application/json:
2128               schema:
2129                 $ref: '#/components/schemas/ErrorMessage'
2130               example:
2131                 status: 400
2132                 message: Bad Request
2133                 details: The provided request is not valid
2134         "401":
2135           description: Unauthorized
2136           content:
2137             application/json:
2138               schema:
2139                 $ref: '#/components/schemas/ErrorMessage'
2140               example:
2141                 status: 401
2142                 message: Unauthorized request
2143                 details: This request is unauthorized
2144         "403":
2145           description: Forbidden
2146           content:
2147             application/json:
2148               schema:
2149                 $ref: '#/components/schemas/ErrorMessage'
2150               example:
2151                 status: 403
2152                 message: Request Forbidden
2153                 details: This request is forbidden
2154         "500":
2155           description: Internal Server Error
2156           content:
2157             application/json:
2158               schema:
2159                 $ref: '#/components/schemas/ErrorMessage'
2160               example:
2161                 status: 500
2162                 message: Internal Server Error
2163                 details: Internal Server Error occurred
2164       x-codegen-request-body-name: xpath
2165 components:
2166   parameters:
2167     apiVersionInPath:
2168       name: apiVersion
2169       in: path
2170       description: apiVersion
2171       required: true
2172       schema:
2173         type: string
2174         enum: [v1, v2]
2175         default: v2
2176   securitySchemes:
2177     basicAuth:
2178       type: http
2179       scheme: basic
2180   schemas:
2181     ErrorMessage:
2182       title: Error
2183       type: object
2184       properties:
2185         status:
2186           type: string
2187         message:
2188           type: string
2189         details:
2190           type: string
2191     AnchorDetails:
2192       title: Anchor details by anchor Name
2193       type: object
2194       properties:
2195         name:
2196           type: string
2197           example: my-anchor
2198         dataspaceName:
2199           type: string
2200           example: my-dataspace
2201         schemaSetName:
2202           type: string
2203           example: my-schema-set
2204     DataspaceDetails:
2205       title: Dataspace details by dataspace Name
2206       type: object
2207       properties:
2208         name:
2209           type: string
2210           example: my-dataspace
2211     MultipartFile:
2212       required:
2213       - file
2214       type: object
2215       properties:
2216         file:
2217           type: string
2218           description: multipartFile
2219           format: binary
2220     SchemaSetDetails:
2221       title: Schema set details by dataspace and schemasetName
2222       required:
2223       - moduleReferences
2224       type: object
2225       properties:
2226         dataspaceName:
2227           type: string
2228           example: my-dataspace
2229         moduleReferences:
2230           type: array
2231           items:
2232             $ref: '#/components/schemas/ModuleReferences'
2233         name:
2234           type: string
2235           example: my-schema-set
2236     ModuleReferences:
2237       title: Module reference object
2238       type: object
2239       properties:
2240         name:
2241           type: string
2242           example: my-module-reference-name
2243         namespace:
2244           type: string
2245           example: my-module-reference-namespace
2246         revision:
2247           type: string
2248           example: my-module-reference-revision
2249   examples:
2250     dataSample:
2251       value:
2252         test:bookstore:
2253           bookstore-name: Chapters
2254           categories:
2255           - code: 1
2256             name: SciFi
2257           - code: 2
2258             name: kids
2259
2260 security:
2261   - basicAuth: []