docs/api/swagger/cps/openapi.yaml

   1 openapi: 3.0.3
   2 info:
   3   contact:
   4     email: onap-discuss@lists.onap.org
   5     name: ONAP
   6     url: https://onap.readthedocs.io
   7   description: Configuration Persistence Service is a Model Driven Generic Database
   8   license:
   9     name: Apache 2.0
  10     url: http://www.apache.org/licenses/LICENSE-2.0
  11   title: ONAP Open API v3 Configuration Persistence Service
  12   version: 3.6.3
  13 servers:
  14 - url: /cps/api
  15 tags:
  16 - description: cps Admin
  17   name: cps-admin
  18 - description: cps Data
  19   name: cps-data
  20 - description: CPS Delta
  21   name: cps-delta
  22 paths:
  23   /v1/dataspaces:
  24     post:
  25       deprecated: true
  26       description: Create a new dataspace
  27       operationId: createDataspace
  28       parameters:
  29       - description: dataspace-name
  30         in: query
  31         name: dataspace-name
  32         required: true
  33         schema:
  34           example: my-dataspace
  35           type: string
  36       responses:
  37         "201":
  38           content:
  39             application/json:
  40               schema:
  41                 example: my-resource
  42                 type: string
  43           description: Created
  44         "400":
  45           content:
  46             application/json:
  47               example:
  48                 status: 400
  49                 message: Bad Request
  50                 details: The provided request is not valid
  51               schema:
  52                 $ref: '#/components/schemas/ErrorMessage'
  53           description: Bad Request
  54         "403":
  55           content:
  56             application/json:
  57               example:
  58                 status: 403
  59                 message: Request Forbidden
  60                 details: This request is forbidden
  61               schema:
  62                 $ref: '#/components/schemas/ErrorMessage'
  63           description: Forbidden
  64         "409":
  65           content:
  66             application/json:
  67               example:
  68                 status: 409
  69                 message: Conflicting request
  70                 details: The request cannot be processed as the resource is in use.
  71               schema:
  72                 $ref: '#/components/schemas/ErrorMessage'
  73           description: Conflict
  74         "500":
  75           content:
  76             application/json:
  77               example:
  78                 status: 500
  79                 message: Internal Server Error
  80                 details: Internal Server Error occurred
  81               schema:
  82                 $ref: '#/components/schemas/ErrorMessage'
  83           description: Internal Server Error
  84       summary: Create a dataspace
  85       tags:
  86       - cps-admin
  87   /{apiVersion}/dataspaces:
  88     delete:
  89       description: Delete a dataspace
  90       operationId: deleteDataspace
  91       parameters:
  92       - description: apiVersion
  93         in: path
  94         name: apiVersion
  95         required: true
  96         schema:
  97           default: v2
  98           enum:
  99           - v1
 100           - v2
 101           type: string
 102       - description: dataspace-name
 103         in: query
 104         name: dataspace-name
 105         required: true
 106         schema:
 107           example: my-dataspace
 108           type: string
 109       responses:
 110         "204":
 111           content: {}
 112           description: No Content
 113         "400":
 114           content:
 115             application/json:
 116               example:
 117                 status: 400
 118                 message: Bad Request
 119                 details: The provided request is not valid
 120               schema:
 121                 $ref: '#/components/schemas/ErrorMessage'
 122           description: Bad Request
 123         "403":
 124           content:
 125             application/json:
 126               example:
 127                 status: 403
 128                 message: Request Forbidden
 129                 details: This request is forbidden
 130               schema:
 131                 $ref: '#/components/schemas/ErrorMessage'
 132           description: Forbidden
 133         "409":
 134           content:
 135             application/json:
 136               example:
 137                 status: 409
 138                 message: Conflicting request
 139                 details: The request cannot be processed as the resource is in use.
 140               schema:
 141                 $ref: '#/components/schemas/ErrorMessage'
 142           description: Conflict
 143         "500":
 144           content:
 145             application/json:
 146               example:
 147                 status: 500
 148                 message: Internal Server Error
 149                 details: Internal Server Error occurred
 150               schema:
 151                 $ref: '#/components/schemas/ErrorMessage'
 152           description: Internal Server Error
 153       summary: Delete a dataspace
 154       tags:
 155       - cps-admin
 156   /v2/dataspaces:
 157     post:
 158       description: Create a new dataspace
 159       operationId: createDataspaceV2
 160       parameters:
 161       - description: dataspace-name
 162         in: query
 163         name: dataspace-name
 164         required: true
 165         schema:
 166           example: my-dataspace
 167           type: string
 168       responses:
 169         "201":
 170           description: Created without response body
 171         "400":
 172           content:
 173             application/json:
 174               example:
 175                 status: 400
 176                 message: Bad Request
 177                 details: The provided request is not valid
 178               schema:
 179                 $ref: '#/components/schemas/ErrorMessage'
 180           description: Bad Request
 181         "403":
 182           content:
 183             application/json:
 184               example:
 185                 status: 403
 186                 message: Request Forbidden
 187                 details: This request is forbidden
 188               schema:
 189                 $ref: '#/components/schemas/ErrorMessage'
 190           description: Forbidden
 191         "409":
 192           content:
 193             application/json:
 194               example:
 195                 status: 409
 196                 message: Conflicting request
 197                 details: The request cannot be processed as the resource is in use.
 198               schema:
 199                 $ref: '#/components/schemas/ErrorMessage'
 200           description: Conflict
 201         "500":
 202           content:
 203             application/json:
 204               example:
 205                 status: 500
 206                 message: Internal Server Error
 207                 details: Internal Server Error occurred
 208               schema:
 209                 $ref: '#/components/schemas/ErrorMessage'
 210           description: Internal Server Error
 211       summary: Create a dataspace
 212       tags:
 213       - cps-admin
 214   /{apiVersion}/admin/dataspaces:
 215     get:
 216       description: Read all dataspaces
 217       operationId: getAllDataspaces
 218       parameters:
 219       - description: apiVersion
 220         in: path
 221         name: apiVersion
 222         required: true
 223         schema:
 224           default: v2
 225           enum:
 226           - v1
 227           - v2
 228           type: string
 229       responses:
 230         "200":
 231           content:
 232             application/json:
 233               schema:
 234                 items:
 235                   $ref: '#/components/schemas/DataspaceDetails'
 236                 type: array
 237           description: OK
 238         "400":
 239           content:
 240             application/json:
 241               example:
 242                 status: 400
 243                 message: Bad Request
 244                 details: The provided request is not valid
 245               schema:
 246                 $ref: '#/components/schemas/ErrorMessage'
 247           description: Bad Request
 248         "403":
 249           content:
 250             application/json:
 251               example:
 252                 status: 403
 253                 message: Request Forbidden
 254                 details: This request is forbidden
 255               schema:
 256                 $ref: '#/components/schemas/ErrorMessage'
 257           description: Forbidden
 258         "500":
 259           content:
 260             application/json:
 261               example:
 262                 status: 500
 263                 message: Internal Server Error
 264                 details: Internal Server Error occurred
 265               schema:
 266                 $ref: '#/components/schemas/ErrorMessage'
 267           description: Internal Server Error
 268       summary: Get all dataspaces
 269       tags:
 270       - cps-admin
 271   /{apiVersion}/admin/dataspaces/{dataspace-name}:
 272     get:
 273       description: Read a dataspace given a dataspace name
 274       operationId: getDataspace
 275       parameters:
 276       - description: apiVersion
 277         in: path
 278         name: apiVersion
 279         required: true
 280         schema:
 281           default: v2
 282           enum:
 283           - v1
 284           - v2
 285           type: string
 286       - description: dataspace-name
 287         in: path
 288         name: dataspace-name
 289         required: true
 290         schema:
 291           example: my-dataspace
 292           type: string
 293       responses:
 294         "200":
 295           content:
 296             application/json:
 297               schema:
 298                 $ref: '#/components/schemas/DataspaceDetails'
 299           description: OK
 300         "400":
 301           content:
 302             application/json:
 303               example:
 304                 status: 400
 305                 message: Bad Request
 306                 details: The provided request is not valid
 307               schema:
 308                 $ref: '#/components/schemas/ErrorMessage'
 309           description: Bad Request
 310         "403":
 311           content:
 312             application/json:
 313               example:
 314                 status: 403
 315                 message: Request Forbidden
 316                 details: This request is forbidden
 317               schema:
 318                 $ref: '#/components/schemas/ErrorMessage'
 319           description: Forbidden
 320         "500":
 321           content:
 322             application/json:
 323               example:
 324                 status: 500
 325                 message: Internal Server Error
 326                 details: Internal Server Error occurred
 327               schema:
 328                 $ref: '#/components/schemas/ErrorMessage'
 329           description: Internal Server Error
 330       summary: Get a dataspace
 331       tags:
 332       - cps-admin
 333   /{apiVersion}/admin/dataspaces/{dataspace-name}/actions/clean:
 334     post:
 335       description: Clean the dataspace (remove orphaned schema sets and modules)
 336       operationId: cleanDataspace
 337       parameters:
 338       - description: apiVersion
 339         in: path
 340         name: apiVersion
 341         required: true
 342         schema:
 343           default: v2
 344           enum:
 345           - v1
 346           - v2
 347           type: string
 348       - description: dataspace-name
 349         in: path
 350         name: dataspace-name
 351         required: true
 352         schema:
 353           example: my-dataspace
 354           type: string
 355       responses:
 356         "204":
 357           content: {}
 358           description: No Content
 359         "400":
 360           content:
 361             application/json:
 362               example:
 363                 status: 400
 364                 message: Bad Request
 365                 details: The provided request is not valid
 366               schema:
 367                 $ref: '#/components/schemas/ErrorMessage'
 368           description: Bad Request
 369         "403":
 370           content:
 371             application/json:
 372               example:
 373                 status: 403
 374                 message: Request Forbidden
 375                 details: This request is forbidden
 376               schema:
 377                 $ref: '#/components/schemas/ErrorMessage'
 378           description: Forbidden
 379         "500":
 380           content:
 381             application/json:
 382               example:
 383                 status: 500
 384                 message: Internal Server Error
 385                 details: Internal Server Error occurred
 386               schema:
 387                 $ref: '#/components/schemas/ErrorMessage'
 388           description: Internal Server Error
 389       summary: Clean the dataspace
 390       tags:
 391       - cps-admin
 392   /v1/dataspaces/{dataspace-name}/anchors:
 393     post:
 394       deprecated: true
 395       description: Create a new anchor in the given dataspace
 396       operationId: createAnchor
 397       parameters:
 398       - description: dataspace-name
 399         in: path
 400         name: dataspace-name
 401         required: true
 402         schema:
 403           example: my-dataspace
 404           type: string
 405       - description: schema-set-name
 406         in: query
 407         name: schema-set-name
 408         required: true
 409         schema:
 410           example: my-schema-set
 411           type: string
 412       - description: anchor-name
 413         in: query
 414         name: anchor-name
 415         required: true
 416         schema:
 417           example: my-anchor
 418           type: string
 419       responses:
 420         "201":
 421           content:
 422             application/json:
 423               schema:
 424                 example: my-resource
 425                 type: string
 426           description: Created
 427         "400":
 428           content:
 429             application/json:
 430               example:
 431                 status: 400
 432                 message: Bad Request
 433                 details: The provided request is not valid
 434               schema:
 435                 $ref: '#/components/schemas/ErrorMessage'
 436           description: Bad Request
 437         "403":
 438           content:
 439             application/json:
 440               example:
 441                 status: 403
 442                 message: Request Forbidden
 443                 details: This request is forbidden
 444               schema:
 445                 $ref: '#/components/schemas/ErrorMessage'
 446           description: Forbidden
 447         "409":
 448           content:
 449             application/json:
 450               example:
 451                 status: 409
 452                 message: Conflicting request
 453                 details: The request cannot be processed as the resource is in use.
 454               schema:
 455                 $ref: '#/components/schemas/ErrorMessage'
 456           description: Conflict
 457         "500":
 458           content:
 459             application/json:
 460               example:
 461                 status: 500
 462                 message: Internal Server Error
 463                 details: Internal Server Error occurred
 464               schema:
 465                 $ref: '#/components/schemas/ErrorMessage'
 466           description: Internal Server Error
 467       summary: Create an anchor
 468       tags:
 469       - cps-admin
 470   /v2/dataspaces/{dataspace-name}/anchors:
 471     post:
 472       description: Create a new anchor in the given dataspace
 473       operationId: createAnchorV2
 474       parameters:
 475       - description: dataspace-name
 476         in: path
 477         name: dataspace-name
 478         required: true
 479         schema:
 480           example: my-dataspace
 481           type: string
 482       - description: schema-set-name
 483         in: query
 484         name: schema-set-name
 485         required: true
 486         schema:
 487           example: my-schema-set
 488           type: string
 489       - description: anchor-name
 490         in: query
 491         name: anchor-name
 492         required: true
 493         schema:
 494           example: my-anchor
 495           type: string
 496       responses:
 497         "201":
 498           description: Created without response body
 499         "400":
 500           content:
 501             application/json:
 502               example:
 503                 status: 400
 504                 message: Bad Request
 505                 details: The provided request is not valid
 506               schema:
 507                 $ref: '#/components/schemas/ErrorMessage'
 508           description: Bad Request
 509         "403":
 510           content:
 511             application/json:
 512               example:
 513                 status: 403
 514                 message: Request Forbidden
 515                 details: This request is forbidden
 516               schema:
 517                 $ref: '#/components/schemas/ErrorMessage'
 518           description: Forbidden
 519         "409":
 520           content:
 521             application/json:
 522               example:
 523                 status: 409
 524                 message: Conflicting request
 525                 details: The request cannot be processed as the resource is in use.
 526               schema:
 527                 $ref: '#/components/schemas/ErrorMessage'
 528           description: Conflict
 529         "500":
 530           content:
 531             application/json:
 532               example:
 533                 status: 500
 534                 message: Internal Server Error
 535                 details: Internal Server Error occurred
 536               schema:
 537                 $ref: '#/components/schemas/ErrorMessage'
 538           description: Internal Server Error
 539       summary: Create an anchor
 540       tags:
 541       - cps-admin
 542   /{apiVersion}/dataspaces/{dataspace-name}/anchors:
 543     get:
 544       description: "Read all anchors, given a dataspace"
 545       operationId: getAnchors
 546       parameters:
 547       - description: apiVersion
 548         in: path
 549         name: apiVersion
 550         required: true
 551         schema:
 552           default: v2
 553           enum:
 554           - v1
 555           - v2
 556           type: string
 557       - description: dataspace-name
 558         in: path
 559         name: dataspace-name
 560         required: true
 561         schema:
 562           example: my-dataspace
 563           type: string
 564       responses:
 565         "200":
 566           content:
 567             application/json:
 568               schema:
 569                 items:
 570                   $ref: '#/components/schemas/AnchorDetails'
 571                 type: array
 572           description: OK
 573         "400":
 574           content:
 575             application/json:
 576               example:
 577                 status: 400
 578                 message: Bad Request
 579                 details: The provided request is not valid
 580               schema:
 581                 $ref: '#/components/schemas/ErrorMessage'
 582           description: Bad Request
 583         "403":
 584           content:
 585             application/json:
 586               example:
 587                 status: 403
 588                 message: Request Forbidden
 589                 details: This request is forbidden
 590               schema:
 591                 $ref: '#/components/schemas/ErrorMessage'
 592           description: Forbidden
 593         "500":
 594           content:
 595             application/json:
 596               example:
 597                 status: 500
 598                 message: Internal Server Error
 599                 details: Internal Server Error occurred
 600               schema:
 601                 $ref: '#/components/schemas/ErrorMessage'
 602           description: Internal Server Error
 603       summary: Get anchors
 604       tags:
 605       - cps-admin
 606   /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}:
 607     delete:
 608       description: Delete an anchor given an anchor name and a dataspace
 609       operationId: deleteAnchor
 610       parameters:
 611       - description: apiVersion
 612         in: path
 613         name: apiVersion
 614         required: true
 615         schema:
 616           default: v2
 617           enum:
 618           - v1
 619           - v2
 620           type: string
 621       - description: dataspace-name
 622         in: path
 623         name: dataspace-name
 624         required: true
 625         schema:
 626           example: my-dataspace
 627           type: string
 628       - description: anchor-name
 629         in: path
 630         name: anchor-name
 631         required: true
 632         schema:
 633           example: my-anchor
 634           type: string
 635       responses:
 636         "204":
 637           content: {}
 638           description: No Content
 639         "400":
 640           content:
 641             application/json:
 642               example:
 643                 status: 400
 644                 message: Bad Request
 645                 details: The provided request is not valid
 646               schema:
 647                 $ref: '#/components/schemas/ErrorMessage'
 648           description: Bad Request
 649         "403":
 650           content:
 651             application/json:
 652               example:
 653                 status: 403
 654                 message: Request Forbidden
 655                 details: This request is forbidden
 656               schema:
 657                 $ref: '#/components/schemas/ErrorMessage'
 658           description: Forbidden
 659         "500":
 660           content:
 661             application/json:
 662               example:
 663                 status: 500
 664                 message: Internal Server Error
 665                 details: Internal Server Error occurred
 666               schema:
 667                 $ref: '#/components/schemas/ErrorMessage'
 668           description: Internal Server Error
 669       summary: Delete an anchor
 670       tags:
 671       - cps-admin
 672     get:
 673       description: Read an anchor given an anchor name and a dataspace
 674       operationId: getAnchor
 675       parameters:
 676       - description: apiVersion
 677         in: path
 678         name: apiVersion
 679         required: true
 680         schema:
 681           default: v2
 682           enum:
 683           - v1
 684           - v2
 685           type: string
 686       - description: dataspace-name
 687         in: path
 688         name: dataspace-name
 689         required: true
 690         schema:
 691           example: my-dataspace
 692           type: string
 693       - description: anchor-name
 694         in: path
 695         name: anchor-name
 696         required: true
 697         schema:
 698           example: my-anchor
 699           type: string
 700       responses:
 701         "200":
 702           content:
 703             application/json:
 704               schema:
 705                 $ref: '#/components/schemas/AnchorDetails'
 706           description: OK
 707         "400":
 708           content:
 709             application/json:
 710               example:
 711                 status: 400
 712                 message: Bad Request
 713                 details: The provided request is not valid
 714               schema:
 715                 $ref: '#/components/schemas/ErrorMessage'
 716           description: Bad Request
 717         "403":
 718           content:
 719             application/json:
 720               example:
 721                 status: 403
 722                 message: Request Forbidden
 723                 details: This request is forbidden
 724               schema:
 725                 $ref: '#/components/schemas/ErrorMessage'
 726           description: Forbidden
 727         "500":
 728           content:
 729             application/json:
 730               example:
 731                 status: 500
 732                 message: Internal Server Error
 733                 details: Internal Server Error occurred
 734               schema:
 735                 $ref: '#/components/schemas/ErrorMessage'
 736           description: Internal Server Error
 737       summary: Get an anchor
 738       tags:
 739       - cps-admin
 740   /v1/dataspaces/{dataspace-name}/schema-sets:
 741     post:
 742       deprecated: true
 743       description: Create a new schema set in the given dataspace
 744       operationId: createSchemaSet
 745       parameters:
 746       - description: dataspace-name
 747         in: path
 748         name: dataspace-name
 749         required: true
 750         schema:
 751           example: my-dataspace
 752           type: string
 753       - description: schema-set-name
 754         in: query
 755         name: schema-set-name
 756         required: true
 757         schema:
 758           example: my-schema-set
 759           type: string
 760       requestBody:
 761         content:
 762           multipart/form-data:
 763             schema:
 764               $ref: '#/components/schemas/MultipartFile'
 765         required: true
 766       responses:
 767         "201":
 768           content:
 769             application/json:
 770               schema:
 771                 example: my-resource
 772                 type: string
 773           description: Created
 774         "400":
 775           content:
 776             application/json:
 777               example:
 778                 status: 400
 779                 message: Bad Request
 780                 details: The provided request is not valid
 781               schema:
 782                 $ref: '#/components/schemas/ErrorMessage'
 783           description: Bad Request
 784         "403":
 785           content:
 786             application/json:
 787               example:
 788                 status: 403
 789                 message: Request Forbidden
 790                 details: This request is forbidden
 791               schema:
 792                 $ref: '#/components/schemas/ErrorMessage'
 793           description: Forbidden
 794         "409":
 795           content:
 796             application/json:
 797               example:
 798                 status: 409
 799                 message: Conflicting request
 800                 details: The request cannot be processed as the resource is in use.
 801               schema:
 802                 $ref: '#/components/schemas/ErrorMessage'
 803           description: Conflict
 804         "500":
 805           content:
 806             application/json:
 807               example:
 808                 status: 500
 809                 message: Internal Server Error
 810                 details: Internal Server Error occurred
 811               schema:
 812                 $ref: '#/components/schemas/ErrorMessage'
 813           description: Internal Server Error
 814       summary: Create a schema set
 815       tags:
 816       - cps-admin
 817   /v2/dataspaces/{dataspace-name}/schema-sets:
 818     post:
 819       description: Create a new schema set in the given dataspace
 820       operationId: createSchemaSetV2
 821       parameters:
 822       - description: dataspace-name
 823         in: path
 824         name: dataspace-name
 825         required: true
 826         schema:
 827           example: my-dataspace
 828           type: string
 829       - description: schema-set-name
 830         in: query
 831         name: schema-set-name
 832         required: true
 833         schema:
 834           example: my-schema-set
 835           type: string
 836       requestBody:
 837         content:
 838           multipart/form-data:
 839             schema:
 840               $ref: '#/components/schemas/MultipartFile'
 841         required: true
 842       responses:
 843         "201":
 844           description: Created without response body
 845         "400":
 846           content:
 847             application/json:
 848               example:
 849                 status: 400
 850                 message: Bad Request
 851                 details: The provided request is not valid
 852               schema:
 853                 $ref: '#/components/schemas/ErrorMessage'
 854           description: Bad Request
 855         "403":
 856           content:
 857             application/json:
 858               example:
 859                 status: 403
 860                 message: Request Forbidden
 861                 details: This request is forbidden
 862               schema:
 863                 $ref: '#/components/schemas/ErrorMessage'
 864           description: Forbidden
 865         "409":
 866           content:
 867             application/json:
 868               example:
 869                 status: 409
 870                 message: Conflicting request
 871                 details: The request cannot be processed as the resource is in use.
 872               schema:
 873                 $ref: '#/components/schemas/ErrorMessage'
 874           description: Conflict
 875         "500":
 876           content:
 877             application/json:
 878               example:
 879                 status: 500
 880                 message: Internal Server Error
 881                 details: Internal Server Error occurred
 882               schema:
 883                 $ref: '#/components/schemas/ErrorMessage'
 884           description: Internal Server Error
 885       summary: Create a schema set
 886       tags:
 887       - cps-admin
 888   /{apiVersion}/dataspaces/{dataspace-name}/schema-sets:
 889     get:
 890       description: "Read all schema sets, given a dataspace"
 891       operationId: getSchemaSets
 892       parameters:
 893       - description: apiVersion
 894         in: path
 895         name: apiVersion
 896         required: true
 897         schema:
 898           default: v2
 899           enum:
 900           - v1
 901           - v2
 902           type: string
 903       - description: dataspace-name
 904         in: path
 905         name: dataspace-name
 906         required: true
 907         schema:
 908           example: my-dataspace
 909           type: string
 910       responses:
 911         "200":
 912           content:
 913             application/json:
 914               schema:
 915                 items:
 916                   $ref: '#/components/schemas/SchemaSetDetails'
 917                 type: array
 918           description: OK
 919         "400":
 920           content:
 921             application/json:
 922               example:
 923                 status: 400
 924                 message: Bad Request
 925                 details: The provided request is not valid
 926               schema:
 927                 $ref: '#/components/schemas/ErrorMessage'
 928           description: Bad Request
 929         "403":
 930           content:
 931             application/json:
 932               example:
 933                 status: 403
 934                 message: Request Forbidden
 935                 details: This request is forbidden
 936               schema:
 937                 $ref: '#/components/schemas/ErrorMessage'
 938           description: Forbidden
 939         "500":
 940           content:
 941             application/json:
 942               example:
 943                 status: 500
 944                 message: Internal Server Error
 945                 details: Internal Server Error occurred
 946               schema:
 947                 $ref: '#/components/schemas/ErrorMessage'
 948           description: Internal Server Error
 949       summary: Get schema sets
 950       tags:
 951       - cps-admin
 952   /{apiVersion}/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}:
 953     delete:
 954       description: Delete a schema set given a schema set name and a dataspace
 955       operationId: deleteSchemaSet
 956       parameters:
 957       - description: apiVersion
 958         in: path
 959         name: apiVersion
 960         required: true
 961         schema:
 962           default: v2
 963           enum:
 964           - v1
 965           - v2
 966           type: string
 967       - description: dataspace-name
 968         in: path
 969         name: dataspace-name
 970         required: true
 971         schema:
 972           example: my-dataspace
 973           type: string
 974       - description: schema-set-name
 975         in: path
 976         name: schema-set-name
 977         required: true
 978         schema:
 979           example: my-schema-set
 980           type: string
 981       responses:
 982         "204":
 983           content: {}
 984           description: No Content
 985         "400":
 986           content:
 987             application/json:
 988               example:
 989                 status: 400
 990                 message: Bad Request
 991                 details: The provided request is not valid
 992               schema:
 993                 $ref: '#/components/schemas/ErrorMessage'
 994           description: Bad Request
 995         "403":
 996           content:
 997             application/json:
 998               example:
 999                 status: 403
1000                 message: Request Forbidden
1001                 details: This request is forbidden
1002               schema:
1003                 $ref: '#/components/schemas/ErrorMessage'
1004           description: Forbidden
1005         "409":
1006           content:
1007             application/json:
1008               example:
1009                 status: 409
1010                 message: Conflicting request
1011                 details: The request cannot be processed as the resource is in use.
1012               schema:
1013                 $ref: '#/components/schemas/ErrorMessage'
1014           description: Conflict
1015         "500":
1016           content:
1017             application/json:
1018               example:
1019                 status: 500
1020                 message: Internal Server Error
1021                 details: Internal Server Error occurred
1022               schema:
1023                 $ref: '#/components/schemas/ErrorMessage'
1024           description: Internal Server Error
1025       summary: Delete a schema set
1026       tags:
1027       - cps-admin
1028     get:
1029       description: Read a schema set given a schema set name and a dataspace
1030       operationId: getSchemaSet
1031       parameters:
1032       - description: apiVersion
1033         in: path
1034         name: apiVersion
1035         required: true
1036         schema:
1037           default: v2
1038           enum:
1039           - v1
1040           - v2
1041           type: string
1042       - description: dataspace-name
1043         in: path
1044         name: dataspace-name
1045         required: true
1046         schema:
1047           example: my-dataspace
1048           type: string
1049       - description: schema-set-name
1050         in: path
1051         name: schema-set-name
1052         required: true
1053         schema:
1054           example: my-schema-set
1055           type: string
1056       responses:
1057         "200":
1058           content:
1059             application/json:
1060               schema:
1061                 $ref: '#/components/schemas/SchemaSetDetails'
1062           description: OK
1063         "400":
1064           content:
1065             application/json:
1066               example:
1067                 status: 400
1068                 message: Bad Request
1069                 details: The provided request is not valid
1070               schema:
1071                 $ref: '#/components/schemas/ErrorMessage'
1072           description: Bad Request
1073         "403":
1074           content:
1075             application/json:
1076               example:
1077                 status: 403
1078                 message: Request Forbidden
1079                 details: This request is forbidden
1080               schema:
1081                 $ref: '#/components/schemas/ErrorMessage'
1082           description: Forbidden
1083         "500":
1084           content:
1085             application/json:
1086               example:
1087                 status: 500
1088                 message: Internal Server Error
1089                 details: Internal Server Error occurred
1090               schema:
1091                 $ref: '#/components/schemas/ErrorMessage'
1092           description: Internal Server Error
1093       summary: Get a schema set
1094       tags:
1095       - cps-admin
1096   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
1097     get:
1098       deprecated: true
1099       description: Get a node with an option to retrieve all the children for a given
1100         anchor and dataspace
1101       operationId: getNodeByDataspaceAndAnchor
1102       parameters:
1103       - description: dataspace-name
1104         in: path
1105         name: dataspace-name
1106         required: true
1107         schema:
1108           example: my-dataspace
1109           type: string
1110       - description: anchor-name
1111         in: path
1112         name: anchor-name
1113         required: true
1114         schema:
1115           example: my-anchor
1116           type: string
1117       - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1118         examples:
1119           container xpath:
1120             value: /shops/bookstore
1121           list attributes xpath:
1122             value: "/shops/bookstore/categories[@code=1]"
1123         in: query
1124         name: xpath
1125         required: false
1126         schema:
1127           default: /
1128           type: string
1129       - description: include-descendants
1130         in: query
1131         name: include-descendants
1132         required: false
1133         schema:
1134           default: false
1135           example: false
1136           type: boolean
1137       responses:
1138         "200":
1139           content:
1140             application/json:
1141               examples:
1142                 dataSample:
1143                   $ref: '#/components/examples/dataSample'
1144               schema:
1145                 type: object
1146           description: OK
1147         "400":
1148           content:
1149             application/json:
1150               example:
1151                 status: 400
1152                 message: Bad Request
1153                 details: The provided request is not valid
1154               schema:
1155                 $ref: '#/components/schemas/ErrorMessage'
1156           description: Bad Request
1157         "403":
1158           content:
1159             application/json:
1160               example:
1161                 status: 403
1162                 message: Request Forbidden
1163                 details: This request is forbidden
1164               schema:
1165                 $ref: '#/components/schemas/ErrorMessage'
1166           description: Forbidden
1167         "500":
1168           content:
1169             application/json:
1170               example:
1171                 status: 500
1172                 message: Internal Server Error
1173                 details: Internal Server Error occurred
1174               schema:
1175                 $ref: '#/components/schemas/ErrorMessage'
1176           description: Internal Server Error
1177       summary: Get a node
1178       tags:
1179       - cps-data
1180       x-codegen-request-body-name: xpath
1181   /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
1182     get:
1183       deprecated: true
1184       description: Get a node with an option to retrieve all the children for a given
1185         anchor and dataspace
1186       operationId: getNodeByDataspaceAndAnchorV2
1187       parameters:
1188       - description: dataspace-name
1189         in: path
1190         name: dataspace-name
1191         required: true
1192         schema:
1193           example: my-dataspace
1194           type: string
1195       - description: anchor-name
1196         in: path
1197         name: anchor-name
1198         required: true
1199         schema:
1200           example: my-anchor
1201           type: string
1202       - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1203         examples:
1204           container xpath:
1205             value: /shops/bookstore
1206           list attributes xpath:
1207             value: "/shops/bookstore/categories[@code=1]"
1208         in: query
1209         name: xpath
1210         required: false
1211         schema:
1212           default: /
1213           type: string
1214       - description: "Number of descendants to query. Allowed values are 'none', 'all',\
1215           \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
1216           \ number."
1217         in: query
1218         name: descendants
1219         required: false
1220         schema:
1221           default: none
1222           example: "3"
1223           type: string
1224       - description: Content type in header
1225         in: header
1226         name: Content-Type
1227         required: false
1228         schema:
1229           default: application/json
1230           enum:
1231           - application/json
1232           - application/xml
1233           type: string
1234       responses:
1235         "200":
1236           content:
1237             application/json:
1238               examples:
1239                 dataSample:
1240                   $ref: '#/components/examples/dataSample'
1241               schema:
1242                 type: object
1243             application/xml:
1244               examples:
1245                 dataSample:
1246                   $ref: '#/components/examples/dataSampleXml'
1247               schema:
1248                 type: object
1249                 xml:
1250                   name: stores
1251           description: OK
1252         "400":
1253           content:
1254             application/json:
1255               example:
1256                 status: 400
1257                 message: Bad Request
1258                 details: The provided request is not valid
1259               schema:
1260                 $ref: '#/components/schemas/ErrorMessage'
1261           description: Bad Request
1262         "403":
1263           content:
1264             application/json:
1265               example:
1266                 status: 403
1267                 message: Request Forbidden
1268                 details: This request is forbidden
1269               schema:
1270                 $ref: '#/components/schemas/ErrorMessage'
1271           description: Forbidden
1272         "500":
1273           content:
1274             application/json:
1275               example:
1276                 status: 500
1277                 message: Internal Server Error
1278                 details: Internal Server Error occurred
1279               schema:
1280                 $ref: '#/components/schemas/ErrorMessage'
1281           description: Internal Server Error
1282       summary: Get a node
1283       tags:
1284       - cps-data
1285       x-codegen-request-body-name: xpath
1286   /v3/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
1287     get:
1288       description: Get a node with an option to retrieve all the children for a given
1289         anchor and dataspace
1290       operationId: getNodeByDataspaceAndAnchorV3
1291       parameters:
1292       - description: dataspace-name
1293         in: path
1294         name: dataspace-name
1295         required: true
1296         schema:
1297           example: my-dataspace
1298           type: string
1299       - description: anchor-name
1300         in: path
1301         name: anchor-name
1302         required: true
1303         schema:
1304           example: my-anchor
1305           type: string
1306       - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1307         examples:
1308           container xpath:
1309             value: /shops/bookstore
1310           list attributes xpath:
1311             value: "/shops/bookstore/categories[@code=1]"
1312         in: query
1313         name: xpath
1314         required: false
1315         schema:
1316           default: /
1317           type: string
1318       - description: "Number of descendants to query. Allowed values are 'none', 'all',\
1319           \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
1320           \ number."
1321         in: query
1322         name: descendants
1323         required: false
1324         schema:
1325           default: none
1326           example: "3"
1327           type: string
1328       - description: Content type in header
1329         in: header
1330         name: Content-Type
1331         required: false
1332         schema:
1333           default: application/json
1334           enum:
1335           - application/json
1336           - application/xml
1337           type: string
1338       responses:
1339         "200":
1340           content:
1341             application/json:
1342               examples:
1343                 dataSample:
1344                   $ref: '#/components/examples/dataSampleForV3'
1345               schema:
1346                 type: object
1347             application/xml:
1348               examples:
1349                 dataSample:
1350                   $ref: '#/components/examples/dataSampleXmlForV3'
1351               schema:
1352                 type: object
1353                 xml:
1354                   name: stores
1355           description: OK
1356         "400":
1357           content:
1358             application/json:
1359               example:
1360                 status: 400
1361                 message: Bad Request
1362                 details: The provided request is not valid
1363               schema:
1364                 $ref: '#/components/schemas/ErrorMessage'
1365           description: Bad Request
1366         "403":
1367           content:
1368             application/json:
1369               example:
1370                 status: 403
1371                 message: Request Forbidden
1372                 details: This request is forbidden
1373               schema:
1374                 $ref: '#/components/schemas/ErrorMessage'
1375           description: Forbidden
1376         "500":
1377           content:
1378             application/json:
1379               example:
1380                 status: 500
1381                 message: Internal Server Error
1382                 details: Internal Server Error occurred
1383               schema:
1384                 $ref: '#/components/schemas/ErrorMessage'
1385           description: Internal Server Error
1386       summary: Get a node
1387       tags:
1388       - cps-data
1389       x-codegen-request-body-name: xpath
1390   /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
1391     delete:
1392       description: Delete a datanode for a given dataspace and anchor given a node
1393         xpath.
1394       operationId: deleteDataNode
1395       parameters:
1396       - description: apiVersion
1397         in: path
1398         name: apiVersion
1399         required: true
1400         schema:
1401           default: v2
1402           enum:
1403           - v1
1404           - v2
1405           type: string
1406       - description: dataspace-name
1407         in: path
1408         name: dataspace-name
1409         required: true
1410         schema:
1411           example: my-dataspace
1412           type: string
1413       - description: anchor-name
1414         in: path
1415         name: anchor-name
1416         required: true
1417         schema:
1418           example: my-anchor
1419           type: string
1420       - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1421         examples:
1422           container xpath:
1423             value: /shops/bookstore
1424           list attributes xpath:
1425             value: "/shops/bookstore/categories[@code=1]"
1426         in: query
1427         name: xpath
1428         required: false
1429         schema:
1430           default: /
1431           type: string
1432       - description: observed-timestamp
1433         in: query
1434         name: observed-timestamp
1435         required: false
1436         schema:
1437           example: 2021-03-21T00:10:34.030-0100
1438           type: string
1439       responses:
1440         "204":
1441           content: {}
1442           description: No Content
1443         "400":
1444           content:
1445             application/json:
1446               example:
1447                 status: 400
1448                 message: Bad Request
1449                 details: The provided request is not valid
1450               schema:
1451                 $ref: '#/components/schemas/ErrorMessage'
1452           description: Bad Request
1453         "403":
1454           content:
1455             application/json:
1456               example:
1457                 status: 403
1458                 message: Request Forbidden
1459                 details: This request is forbidden
1460               schema:
1461                 $ref: '#/components/schemas/ErrorMessage'
1462           description: Forbidden
1463         "500":
1464           content:
1465             application/json:
1466               example:
1467                 status: 500
1468                 message: Internal Server Error
1469                 details: Internal Server Error occurred
1470               schema:
1471                 $ref: '#/components/schemas/ErrorMessage'
1472           description: Internal Server Error
1473       summary: Delete a data node
1474       tags:
1475       - cps-data
1476     patch:
1477       description: Update a data node leaves for a given dataspace and anchor and
1478         a parent node xpath. This operation is currently supported for one top level
1479         data node only.
1480       operationId: updateNodeLeaves
1481       parameters:
1482       - description: apiVersion
1483         in: path
1484         name: apiVersion
1485         required: true
1486         schema:
1487           default: v2
1488           enum:
1489           - v1
1490           - v2
1491           type: string
1492       - description: dataspace-name
1493         in: path
1494         name: dataspace-name
1495         required: true
1496         schema:
1497           example: my-dataspace
1498           type: string
1499       - description: anchor-name
1500         in: path
1501         name: anchor-name
1502         required: true
1503         schema:
1504           example: my-anchor
1505           type: string
1506       - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1507         examples:
1508           container xpath:
1509             value: /shops/bookstore
1510           list attributes xpath:
1511             value: "/shops/bookstore/categories[@code=1]"
1512         in: query
1513         name: xpath
1514         required: false
1515         schema:
1516           default: /
1517           type: string
1518       - description: "Boolean flag to validate data, without persisting it. Default\
1519           \ value is false."
1520         in: query
1521         name: dry-run
1522         required: false
1523         schema:
1524           default: false
1525           example: false
1526           type: boolean
1527       - description: observed-timestamp
1528         in: query
1529         name: observed-timestamp
1530         required: false
1531         schema:
1532           example: 2021-03-21T00:10:34.030-0100
1533           type: string
1534       - description: Content type in header
1535         in: header
1536         name: Content-Type
1537         required: false
1538         schema:
1539           default: application/json
1540           enum:
1541           - application/json
1542           - application/xml
1543           type: string
1544       requestBody:
1545         content:
1546           application/json:
1547             examples:
1548               dataSample:
1549                 $ref: '#/components/examples/dataSample'
1550             schema:
1551               type: string
1552           application/xml:
1553             examples:
1554               dataSample:
1555                 $ref: '#/components/examples/dataSampleXml'
1556             schema:
1557               type: object
1558               xml:
1559                 name: stores
1560         required: true
1561       responses:
1562         "200":
1563           content:
1564             application/json:
1565               examples:
1566                 dataSample:
1567                   value: ""
1568               schema:
1569                 type: object
1570           description: OK
1571         "400":
1572           content:
1573             application/json:
1574               example:
1575                 status: 400
1576                 message: Bad Request
1577                 details: The provided request is not valid
1578               schema:
1579                 $ref: '#/components/schemas/ErrorMessage'
1580           description: Bad Request
1581         "403":
1582           content:
1583             application/json:
1584               example:
1585                 status: 403
1586                 message: Request Forbidden
1587                 details: This request is forbidden
1588               schema:
1589                 $ref: '#/components/schemas/ErrorMessage'
1590           description: Forbidden
1591         "500":
1592           content:
1593             application/json:
1594               example:
1595                 status: 500
1596                 message: Internal Server Error
1597                 details: Internal Server Error occurred
1598               schema:
1599                 $ref: '#/components/schemas/ErrorMessage'
1600           description: Internal Server Error
1601       summary: Update node leaves
1602       tags:
1603       - cps-data
1604     post:
1605       description: Create a node for a given anchor and dataspace
1606       operationId: createNode
1607       parameters:
1608       - description: apiVersion
1609         in: path
1610         name: apiVersion
1611         required: true
1612         schema:
1613           default: v2
1614           enum:
1615           - v1
1616           - v2
1617           type: string
1618       - description: dataspace-name
1619         in: path
1620         name: dataspace-name
1621         required: true
1622         schema:
1623           example: my-dataspace
1624           type: string
1625       - description: anchor-name
1626         in: path
1627         name: anchor-name
1628         required: true
1629         schema:
1630           example: my-anchor
1631           type: string
1632       - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1633         examples:
1634           container xpath:
1635             value: /shops/bookstore
1636           list attributes xpath:
1637             value: "/shops/bookstore/categories[@code=1]"
1638         in: query
1639         name: xpath
1640         required: false
1641         schema:
1642           default: /
1643           type: string
1644       - description: "Boolean flag to validate data, without persisting it. Default\
1645           \ value is false."
1646         in: query
1647         name: dry-run
1648         required: false
1649         schema:
1650           default: false
1651           example: false
1652           type: boolean
1653       - description: observed-timestamp
1654         in: query
1655         name: observed-timestamp
1656         required: false
1657         schema:
1658           example: 2021-03-21T00:10:34.030-0100
1659           type: string
1660       - description: Content type in header
1661         in: header
1662         name: Content-Type
1663         required: false
1664         schema:
1665           default: application/json
1666           enum:
1667           - application/json
1668           - application/xml
1669           type: string
1670       requestBody:
1671         content:
1672           application/json:
1673             examples:
1674               dataSample:
1675                 $ref: '#/components/examples/dataSample'
1676             schema:
1677               type: string
1678           application/xml:
1679             examples:
1680               dataSample:
1681                 $ref: '#/components/examples/dataSampleXml'
1682             schema:
1683               type: object
1684               xml:
1685                 name: stores
1686         required: true
1687       responses:
1688         "201":
1689           content:
1690             application/json:
1691               schema:
1692                 example: my-resource
1693                 type: string
1694           description: Created
1695         "400":
1696           content:
1697             application/json:
1698               example:
1699                 status: 400
1700                 message: Bad Request
1701                 details: The provided request is not valid
1702               schema:
1703                 $ref: '#/components/schemas/ErrorMessage'
1704           description: Bad Request
1705         "403":
1706           content:
1707             application/json:
1708               example:
1709                 status: 403
1710                 message: Request Forbidden
1711                 details: This request is forbidden
1712               schema:
1713                 $ref: '#/components/schemas/ErrorMessage'
1714           description: Forbidden
1715         "409":
1716           content:
1717             application/json:
1718               example:
1719                 status: 409
1720                 message: Conflicting request
1721                 details: The request cannot be processed as the resource is in use.
1722               schema:
1723                 $ref: '#/components/schemas/ErrorMessage'
1724           description: Conflict
1725         "500":
1726           content:
1727             application/json:
1728               example:
1729                 status: 500
1730                 message: Internal Server Error
1731                 details: Internal Server Error occurred
1732               schema:
1733                 $ref: '#/components/schemas/ErrorMessage'
1734           description: Internal Server Error
1735       summary: Create a node
1736       tags:
1737       - cps-data
1738     put:
1739       description: "Replace a node with descendants for a given dataspace, anchor\
1740         \ and a parent node xpath"
1741       operationId: replaceNode
1742       parameters:
1743       - description: apiVersion
1744         in: path
1745         name: apiVersion
1746         required: true
1747         schema:
1748           default: v2
1749           enum:
1750           - v1
1751           - v2
1752           type: string
1753       - description: dataspace-name
1754         in: path
1755         name: dataspace-name
1756         required: true
1757         schema:
1758           example: my-dataspace
1759           type: string
1760       - description: anchor-name
1761         in: path
1762         name: anchor-name
1763         required: true
1764         schema:
1765           example: my-anchor
1766           type: string
1767       - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1768         examples:
1769           container xpath:
1770             value: /shops/bookstore
1771           list attributes xpath:
1772             value: "/shops/bookstore/categories[@code=1]"
1773         in: query
1774         name: xpath
1775         required: false
1776         schema:
1777           default: /
1778           type: string
1779       - description: "Boolean flag to validate data, without persisting it. Default\
1780           \ value is false."
1781         in: query
1782         name: dry-run
1783         required: false
1784         schema:
1785           default: false
1786           example: false
1787           type: boolean
1788       - description: observed-timestamp
1789         in: query
1790         name: observed-timestamp
1791         required: false
1792         schema:
1793           example: 2021-03-21T00:10:34.030-0100
1794           type: string
1795       - description: Content type in header
1796         in: header
1797         name: Content-Type
1798         required: false
1799         schema:
1800           default: application/json
1801           enum:
1802           - application/json
1803           - application/xml
1804           type: string
1805       requestBody:
1806         content:
1807           application/json:
1808             examples:
1809               dataSample:
1810                 $ref: '#/components/examples/dataSample'
1811             schema:
1812               type: string
1813           application/xml:
1814             examples:
1815               dataSample:
1816                 $ref: '#/components/examples/dataSampleXml'
1817             schema:
1818               type: object
1819               xml:
1820                 name: stores
1821         required: true
1822       responses:
1823         "200":
1824           content:
1825             application/json:
1826               examples:
1827                 dataSample:
1828                   value: ""
1829               schema:
1830                 type: object
1831           description: OK
1832         "400":
1833           content:
1834             application/json:
1835               example:
1836                 status: 400
1837                 message: Bad Request
1838                 details: The provided request is not valid
1839               schema:
1840                 $ref: '#/components/schemas/ErrorMessage'
1841           description: Bad Request
1842         "403":
1843           content:
1844             application/json:
1845               example:
1846                 status: 403
1847                 message: Request Forbidden
1848                 details: This request is forbidden
1849               schema:
1850                 $ref: '#/components/schemas/ErrorMessage'
1851           description: Forbidden
1852         "500":
1853           content:
1854             application/json:
1855               example:
1856                 status: 500
1857                 message: Internal Server Error
1858                 details: Internal Server Error occurred
1859               schema:
1860                 $ref: '#/components/schemas/ErrorMessage'
1861           description: Internal Server Error
1862       summary: Replace a node with descendants
1863       tags:
1864       - cps-data
1865   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
1866     delete:
1867       deprecated: true
1868       description: Delete one or all list element(s) for a given anchor and dataspace
1869       operationId: deleteListOrListElement
1870       parameters:
1871       - description: dataspace-name
1872         in: path
1873         name: dataspace-name
1874         required: true
1875         schema:
1876           example: my-dataspace
1877           type: string
1878       - description: anchor-name
1879         in: path
1880         name: anchor-name
1881         required: true
1882         schema:
1883           example: my-anchor
1884           type: string
1885       - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1886         examples:
1887           container xpath:
1888             value: /shops/bookstore
1889           list attributes xpath:
1890             value: "/shops/bookstore/categories[@code=1]"
1891         in: query
1892         name: xpath
1893         required: true
1894         schema:
1895           type: string
1896       - description: observed-timestamp
1897         in: query
1898         name: observed-timestamp
1899         required: false
1900         schema:
1901           example: 2021-03-21T00:10:34.030-0100
1902           type: string
1903       responses:
1904         "204":
1905           content: {}
1906           description: No Content
1907         "400":
1908           content:
1909             application/json:
1910               example:
1911                 status: 400
1912                 message: Bad Request
1913                 details: The provided request is not valid
1914               schema:
1915                 $ref: '#/components/schemas/ErrorMessage'
1916           description: Bad Request
1917         "403":
1918           content:
1919             application/json:
1920               example:
1921                 status: 403
1922                 message: Request Forbidden
1923                 details: This request is forbidden
1924               schema:
1925                 $ref: '#/components/schemas/ErrorMessage'
1926           description: Forbidden
1927         "500":
1928           content:
1929             application/json:
1930               example:
1931                 status: 500
1932                 message: Internal Server Error
1933                 details: Internal Server Error occurred
1934               schema:
1935                 $ref: '#/components/schemas/ErrorMessage'
1936           description: Internal Server Error
1937       summary: Delete one or all list element(s)
1938       tags:
1939       - cps-data
1940   /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
1941     post:
1942       description: Add list element(s) to a list for a given anchor and dataspace
1943       operationId: addListElements
1944       parameters:
1945       - description: apiVersion
1946         in: path
1947         name: apiVersion
1948         required: true
1949         schema:
1950           default: v2
1951           enum:
1952           - v1
1953           - v2
1954           type: string
1955       - description: dataspace-name
1956         in: path
1957         name: dataspace-name
1958         required: true
1959         schema:
1960           example: my-dataspace
1961           type: string
1962       - description: anchor-name
1963         in: path
1964         name: anchor-name
1965         required: true
1966         schema:
1967           example: my-anchor
1968           type: string
1969       - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1970         examples:
1971           container xpath:
1972             value: /shops/bookstore
1973           list attributes xpath:
1974             value: "/shops/bookstore/categories[@code=1]"
1975         in: query
1976         name: xpath
1977         required: true
1978         schema:
1979           type: string
1980       - description: "Boolean flag to validate data, without persisting it. Default\
1981           \ value is false."
1982         in: query
1983         name: dry-run
1984         required: false
1985         schema:
1986           default: false
1987           example: false
1988           type: boolean
1989       - description: observed-timestamp
1990         in: query
1991         name: observed-timestamp
1992         required: false
1993         schema:
1994           example: 2021-03-21T00:10:34.030-0100
1995           type: string
1996       - description: Content type in header
1997         in: header
1998         name: Content-Type
1999         required: false
2000         schema:
2001           default: application/json
2002           enum:
2003           - application/json
2004           - application/xml
2005           type: string
2006       requestBody:
2007         content:
2008           application/json:
2009             examples:
2010               dataSample:
2011                 $ref: '#/components/examples/dataSample'
2012             schema:
2013               type: string
2014           application/xml:
2015             examples:
2016               dataSample:
2017                 $ref: '#/components/examples/dataSampleXml'
2018             schema:
2019               type: object
2020               xml:
2021                 name: stores
2022         required: true
2023       responses:
2024         "201":
2025           content:
2026             application/json:
2027               schema:
2028                 example: my-resource
2029                 type: string
2030           description: Created
2031         "400":
2032           content:
2033             application/json:
2034               example:
2035                 status: 400
2036                 message: Bad Request
2037                 details: The provided request is not valid
2038               schema:
2039                 $ref: '#/components/schemas/ErrorMessage'
2040           description: Bad Request
2041         "403":
2042           content:
2043             application/json:
2044               example:
2045                 status: 403
2046                 message: Request Forbidden
2047                 details: This request is forbidden
2048               schema:
2049                 $ref: '#/components/schemas/ErrorMessage'
2050           description: Forbidden
2051         "500":
2052           content:
2053             application/json:
2054               example:
2055                 status: 500
2056                 message: Internal Server Error
2057                 details: Internal Server Error occurred
2058               schema:
2059                 $ref: '#/components/schemas/ErrorMessage'
2060           description: Internal Server Error
2061       summary: Add list element(s)
2062       tags:
2063       - cps-data
2064     put:
2065       description: "Replace list content under a given parent, anchor and dataspace"
2066       operationId: replaceListContent
2067       parameters:
2068       - description: apiVersion
2069         in: path
2070         name: apiVersion
2071         required: true
2072         schema:
2073           default: v2
2074           enum:
2075           - v1
2076           - v2
2077           type: string
2078       - description: dataspace-name
2079         in: path
2080         name: dataspace-name
2081         required: true
2082         schema:
2083           example: my-dataspace
2084           type: string
2085       - description: anchor-name
2086         in: path
2087         name: anchor-name
2088         required: true
2089         schema:
2090           example: my-anchor
2091           type: string
2092       - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
2093         examples:
2094           container xpath:
2095             value: /shops/bookstore
2096           list attributes xpath:
2097             value: "/shops/bookstore/categories[@code=1]"
2098         in: query
2099         name: xpath
2100         required: true
2101         schema:
2102           type: string
2103       - description: "Boolean flag to validate data, without persisting it. Default\
2104           \ value is false."
2105         in: query
2106         name: dry-run
2107         required: false
2108         schema:
2109           default: false
2110           example: false
2111           type: boolean
2112       - description: observed-timestamp
2113         in: query
2114         name: observed-timestamp
2115         required: false
2116         schema:
2117           example: 2021-03-21T00:10:34.030-0100
2118           type: string
2119       - description: Content type in header
2120         in: header
2121         name: Content-Type
2122         required: false
2123         schema:
2124           default: application/json
2125           enum:
2126           - application/json
2127           - application/xml
2128           type: string
2129       requestBody:
2130         content:
2131           application/json:
2132             examples:
2133               dataSample:
2134                 $ref: '#/components/examples/dataSample'
2135             schema:
2136               type: string
2137           application/xml:
2138             examples:
2139               dataSample:
2140                 $ref: '#/components/examples/dataSampleXml'
2141             schema:
2142               type: object
2143               xml:
2144                 name: stores
2145         required: true
2146       responses:
2147         "200":
2148           content:
2149             application/json:
2150               examples:
2151                 dataSample:
2152                   value: ""
2153               schema:
2154                 type: object
2155           description: OK
2156         "400":
2157           content:
2158             application/json:
2159               example:
2160                 status: 400
2161                 message: Bad Request
2162                 details: The provided request is not valid
2163               schema:
2164                 $ref: '#/components/schemas/ErrorMessage'
2165           description: Bad Request
2166         "403":
2167           content:
2168             application/json:
2169               example:
2170                 status: 403
2171                 message: Request Forbidden
2172                 details: This request is forbidden
2173               schema:
2174                 $ref: '#/components/schemas/ErrorMessage'
2175           description: Forbidden
2176         "500":
2177           content:
2178             application/json:
2179               example:
2180                 status: 500
2181                 message: Internal Server Error
2182                 details: Internal Server Error occurred
2183               schema:
2184                 $ref: '#/components/schemas/ErrorMessage'
2185           description: Internal Server Error
2186       summary: Replace list content
2187       tags:
2188       - cps-data
2189   /v2/dataspaces/{dataspace-name}/anchors/{source-anchor-name}/delta:
2190     get:
2191       description: Get delta between two anchors within a given dataspace
2192       operationId: getDeltaByDataspaceAndAnchors
2193       parameters:
2194       - description: dataspace-name
2195         in: path
2196         name: dataspace-name
2197         required: true
2198         schema:
2199           example: my-dataspace
2200           type: string
2201       - description: source-anchor-name
2202         in: path
2203         name: source-anchor-name
2204         required: true
2205         schema:
2206           example: my-anchor
2207           type: string
2208       - description: target-anchor-name
2209         in: query
2210         name: target-anchor-name
2211         required: true
2212         schema:
2213           example: my-anchor
2214           type: string
2215       - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
2216         examples:
2217           container xpath:
2218             value: /shops/bookstore
2219           list attributes xpath:
2220             value: "/shops/bookstore/categories[@code=1]"
2221         in: query
2222         name: xpath
2223         required: false
2224         schema:
2225           default: /
2226           type: string
2227       - description: "Number of descendants to query. Allowed values are 'none', 'all',\
2228           \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
2229           \ number."
2230         in: query
2231         name: descendants
2232         required: false
2233         schema:
2234           default: none
2235           example: "3"
2236           type: string
2237       - description: Boolean flag to enable or disable grouping of data nodes. Enabling
2238           it generates a condensed delta report.
2239         in: query
2240         name: grouping-enabled
2241         required: false
2242         schema:
2243           default: false
2244           example: true
2245           type: boolean
2246       responses:
2247         "200":
2248           content:
2249             application/json:
2250               examples:
2251                 dataSample:
2252                   $ref: '#/components/examples/deltaReportSample'
2253               schema:
2254                 type: object
2255           description: OK
2256         "400":
2257           content:
2258             application/json:
2259               example:
2260                 status: 400
2261                 message: Bad Request
2262                 details: The provided request is not valid
2263               schema:
2264                 $ref: '#/components/schemas/ErrorMessage'
2265           description: Bad Request
2266         "403":
2267           content:
2268             application/json:
2269               example:
2270                 status: 403
2271                 message: Request Forbidden
2272                 details: This request is forbidden
2273               schema:
2274                 $ref: '#/components/schemas/ErrorMessage'
2275           description: Forbidden
2276         "500":
2277           content:
2278             application/json:
2279               example:
2280                 status: 500
2281                 message: Internal Server Error
2282                 details: Internal Server Error occurred
2283               schema:
2284                 $ref: '#/components/schemas/ErrorMessage'
2285           description: Internal Server Error
2286       summary: Get delta between anchors in the same dataspace
2287       tags:
2288       - cps-delta
2289       x-codegen-request-body-name: xpath
2290     post:
2291       description: Get delta between an anchor in a dataspace and JSON payload
2292       operationId: getDeltaByDataspaceAnchorAndPayload
2293       parameters:
2294       - description: dataspace-name
2295         in: path
2296         name: dataspace-name
2297         required: true
2298         schema:
2299           example: my-dataspace
2300           type: string
2301       - description: source-anchor-name
2302         in: path
2303         name: source-anchor-name
2304         required: true
2305         schema:
2306           example: my-anchor
2307           type: string
2308       - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
2309         examples:
2310           container xpath:
2311             value: /shops/bookstore
2312           list attributes xpath:
2313             value: "/shops/bookstore/categories[@code=1]"
2314         in: query
2315         name: xpath
2316         required: false
2317         schema:
2318           default: /
2319           type: string
2320       - description: Boolean flag to enable or disable grouping of data nodes. Enabling
2321           it generates a condensed delta report.
2322         in: query
2323         name: grouping-enabled
2324         required: false
2325         schema:
2326           default: false
2327           example: true
2328           type: boolean
2329       requestBody:
2330         content:
2331           multipart/form-data:
2332             schema:
2333               $ref: '#/components/schemas/getDeltaByDataspaceAnchorAndPayload_request'
2334       responses:
2335         "200":
2336           content:
2337             application/json:
2338               examples:
2339                 dataSample:
2340                   $ref: '#/components/examples/deltaReportSample'
2341               schema:
2342                 type: object
2343           description: OK
2344         "400":
2345           content:
2346             application/json:
2347               example:
2348                 status: 400
2349                 message: Bad Request
2350                 details: The provided request is not valid
2351               schema:
2352                 $ref: '#/components/schemas/ErrorMessage'
2353           description: Bad Request
2354         "401":
2355           content:
2356             application/json:
2357               example:
2358                 status: 401
2359                 message: Unauthorized request
2360                 details: This request is unauthorized
2361               schema:
2362                 $ref: '#/components/schemas/ErrorMessage'
2363           description: Unauthorized
2364         "403":
2365           content:
2366             application/json:
2367               example:
2368                 status: 403
2369                 message: Request Forbidden
2370                 details: This request is forbidden
2371               schema:
2372                 $ref: '#/components/schemas/ErrorMessage'
2373           description: Forbidden
2374         "500":
2375           content:
2376             application/json:
2377               example:
2378                 status: 500
2379                 message: Internal Server Error
2380                 details: Internal Server Error occurred
2381               schema:
2382                 $ref: '#/components/schemas/ErrorMessage'
2383           description: Internal Server Error
2384       summary: Get delta between an anchor and JSON payload
2385       tags:
2386       - cps-delta
2387   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
2388     get:
2389       deprecated: true
2390       description: Query data nodes for the given dataspace and anchor using CPS path
2391       operationId: getNodesByDataspaceAndAnchorAndCpsPath
2392       parameters:
2393       - description: dataspace-name
2394         in: path
2395         name: dataspace-name
2396         required: true
2397         schema:
2398           example: my-dataspace
2399           type: string
2400       - description: anchor-name
2401         in: path
2402         name: anchor-name
2403         required: true
2404         schema:
2405           example: my-anchor
2406           type: string
2407       - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2408         examples:
2409           container cps path:
2410             value: //bookstore
2411           list attributes cps path:
2412             value: "//categories[@code=1]"
2413         in: query
2414         name: cps-path
2415         required: false
2416         schema:
2417           default: /
2418           type: string
2419       - description: include-descendants
2420         in: query
2421         name: include-descendants
2422         required: false
2423         schema:
2424           default: false
2425           example: false
2426           type: boolean
2427       responses:
2428         "200":
2429           content:
2430             application/json:
2431               examples:
2432                 dataSample:
2433                   $ref: '#/components/examples/dataSample'
2434               schema:
2435                 type: object
2436           description: OK
2437         "400":
2438           content:
2439             application/json:
2440               example:
2441                 status: 400
2442                 message: Bad Request
2443                 details: The provided request is not valid
2444               schema:
2445                 $ref: '#/components/schemas/ErrorMessage'
2446           description: Bad Request
2447         "403":
2448           content:
2449             application/json:
2450               example:
2451                 status: 403
2452                 message: Request Forbidden
2453                 details: This request is forbidden
2454               schema:
2455                 $ref: '#/components/schemas/ErrorMessage'
2456           description: Forbidden
2457         "500":
2458           content:
2459             application/json:
2460               example:
2461                 status: 500
2462                 message: Internal Server Error
2463                 details: Internal Server Error occurred
2464               schema:
2465                 $ref: '#/components/schemas/ErrorMessage'
2466           description: Internal Server Error
2467       summary: Query data nodes
2468       tags:
2469       - cps-query
2470       x-codegen-request-body-name: xpath
2471   /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
2472     get:
2473       description: Query data nodes for the given dataspace and anchor using CPS path
2474       operationId: getNodesByDataspaceAndAnchorAndCpsPathV2
2475       parameters:
2476       - description: dataspace-name
2477         in: path
2478         name: dataspace-name
2479         required: true
2480         schema:
2481           example: my-dataspace
2482           type: string
2483       - description: anchor-name
2484         in: path
2485         name: anchor-name
2486         required: true
2487         schema:
2488           example: my-anchor
2489           type: string
2490       - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2491         examples:
2492           container cps path:
2493             value: //bookstore
2494           list attributes cps path:
2495             value: "//categories[@code=1]"
2496         in: query
2497         name: cps-path
2498         required: false
2499         schema:
2500           default: /
2501           type: string
2502       - description: "Number of descendants to query. Allowed values are 'none', 'all',\
2503           \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
2504           \ number."
2505         in: query
2506         name: descendants
2507         required: false
2508         schema:
2509           default: none
2510           example: "3"
2511           type: string
2512       - description: Content type in header
2513         in: header
2514         name: Content-Type
2515         required: false
2516         schema:
2517           default: application/json
2518           enum:
2519           - application/json
2520           - application/xml
2521           type: string
2522       responses:
2523         "200":
2524           content:
2525             application/json:
2526               examples:
2527                 dataSample:
2528                   $ref: '#/components/examples/dataSample'
2529               schema:
2530                 type: object
2531             application/xml:
2532               examples:
2533                 dataSample:
2534                   $ref: '#/components/examples/dataSampleXml'
2535               schema:
2536                 type: object
2537                 xml:
2538                   name: stores
2539           description: OK
2540         "400":
2541           content:
2542             application/json:
2543               example:
2544                 status: 400
2545                 message: Bad Request
2546                 details: The provided request is not valid
2547               schema:
2548                 $ref: '#/components/schemas/ErrorMessage'
2549           description: Bad Request
2550         "403":
2551           content:
2552             application/json:
2553               example:
2554                 status: 403
2555                 message: Request Forbidden
2556                 details: This request is forbidden
2557               schema:
2558                 $ref: '#/components/schemas/ErrorMessage'
2559           description: Forbidden
2560         "500":
2561           content:
2562             application/json:
2563               example:
2564                 status: 500
2565                 message: Internal Server Error
2566                 details: Internal Server Error occurred
2567               schema:
2568                 $ref: '#/components/schemas/ErrorMessage'
2569           description: Internal Server Error
2570       summary: Query data nodes
2571       tags:
2572       - cps-query
2573       x-codegen-request-body-name: xpath
2574   /v2/dataspaces/{dataspace-name}/nodes/query:
2575     get:
2576       description: Query data nodes for the given dataspace across anchors using CPS
2577         path
2578       operationId: getNodesByDataspaceAndCpsPath
2579       parameters:
2580       - description: dataspace-name
2581         in: path
2582         name: dataspace-name
2583         required: true
2584         schema:
2585           example: my-dataspace
2586           type: string
2587       - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2588         examples:
2589           container cps path:
2590             value: //bookstore
2591           list attributes cps path:
2592             value: "//categories[@code=1]"
2593         in: query
2594         name: cps-path
2595         required: false
2596         schema:
2597           default: /
2598           type: string
2599       - description: "Number of descendants to query. Allowed values are 'none', 'all',\
2600           \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
2601           \ number."
2602         in: query
2603         name: descendants
2604         required: false
2605         schema:
2606           default: none
2607           example: "3"
2608           type: string
2609       - description: page index for pagination over anchors. It must be greater then
2610           zero if provided.
2611         in: query
2612         name: pageIndex
2613         required: false
2614         schema:
2615           example: 1
2616           type: integer
2617       - description: number of records (anchors) per page. It must be greater then
2618           zero if provided.
2619         in: query
2620         name: pageSize
2621         required: false
2622         schema:
2623           example: 10
2624           type: integer
2625       responses:
2626         "200":
2627           content:
2628             application/json:
2629               examples:
2630                 dataSample:
2631                   $ref: '#/components/examples/dataSampleAcrossAnchors'
2632               schema:
2633                 type: object
2634           description: OK
2635         "400":
2636           content:
2637             application/json:
2638               example:
2639                 status: 400
2640                 message: Bad Request
2641                 details: The provided request is not valid
2642               schema:
2643                 $ref: '#/components/schemas/ErrorMessage'
2644           description: Bad Request
2645         "403":
2646           content:
2647             application/json:
2648               example:
2649                 status: 403
2650                 message: Request Forbidden
2651                 details: This request is forbidden
2652               schema:
2653                 $ref: '#/components/schemas/ErrorMessage'
2654           description: Forbidden
2655         "500":
2656           content:
2657             application/json:
2658               example:
2659                 status: 500
2660                 message: Internal Server Error
2661                 details: Internal Server Error occurred
2662               schema:
2663                 $ref: '#/components/schemas/ErrorMessage'
2664           description: Internal Server Error
2665       summary: Query data nodes across anchors
2666       tags:
2667       - cps-query
2668       x-codegen-request-body-name: xpath
2669   /v2/notification-subscription:
2670     delete:
2671       description: Delete cps notification subscription
2672       operationId: deleteNotificationSubscription
2673       parameters:
2674       - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
2675         examples:
2676           subscription by dataspace xpath:
2677             value: "/dataspaces/dataspace[@name='dataspace01']"
2678           subscription by anchor xpath:
2679             value: "/dataspaces/dataspace[@name='dataspace01']/anchors/anchor[@name='anchor01']"
2680         in: query
2681         name: xpath
2682         required: true
2683         schema:
2684           default: /dataspaces
2685           type: string
2686       responses:
2687         "204":
2688           content: {}
2689           description: No Content
2690         "400":
2691           content:
2692             application/json:
2693               example:
2694                 status: 400
2695                 message: Bad Request
2696                 details: The provided request is not valid
2697               schema:
2698                 $ref: '#/components/schemas/ErrorMessage'
2699           description: Bad Request
2700         "403":
2701           content:
2702             application/json:
2703               example:
2704                 status: 403
2705                 message: Request Forbidden
2706                 details: This request is forbidden
2707               schema:
2708                 $ref: '#/components/schemas/ErrorMessage'
2709           description: Forbidden
2710         "409":
2711           content:
2712             application/json:
2713               example:
2714                 status: 409
2715                 message: Conflicting request
2716                 details: The request cannot be processed as the resource is in use.
2717               schema:
2718                 $ref: '#/components/schemas/ErrorMessage'
2719           description: Conflict
2720         "500":
2721           content:
2722             application/json:
2723               example:
2724                 status: 500
2725                 message: Internal Server Error
2726                 details: Internal Server Error occurred
2727               schema:
2728                 $ref: '#/components/schemas/ErrorMessage'
2729           description: Internal Server Error
2730       summary: Delete cps notification subscription
2731       tags:
2732       - cps-admin
2733     get:
2734       description: Get cps notification subscription
2735       operationId: getNotificationSubscription
2736       parameters:
2737       - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
2738         examples:
2739           subscription by dataspace xpath:
2740             value: "/dataspaces/dataspace[@name='dataspace01']"
2741           subscription by anchor xpath:
2742             value: "/dataspaces/dataspace[@name='dataspace01']/anchors/anchor[@name='anchor01']"
2743         in: query
2744         name: xpath
2745         required: true
2746         schema:
2747           default: /dataspaces
2748           type: string
2749       responses:
2750         "200":
2751           content:
2752             application/json:
2753               schema:
2754                 $ref: '#/components/schemas/NotificationSubscriptionsDataSample'
2755           description: OK
2756         "400":
2757           content:
2758             application/json:
2759               example:
2760                 status: 400
2761                 message: Bad Request
2762                 details: The provided request is not valid
2763               schema:
2764                 $ref: '#/components/schemas/ErrorMessage'
2765           description: Bad Request
2766         "403":
2767           content:
2768             application/json:
2769               example:
2770                 status: 403
2771                 message: Request Forbidden
2772                 details: This request is forbidden
2773               schema:
2774                 $ref: '#/components/schemas/ErrorMessage'
2775           description: Forbidden
2776         "409":
2777           content:
2778             application/json:
2779               example:
2780                 status: 409
2781                 message: Conflicting request
2782                 details: The request cannot be processed as the resource is in use.
2783               schema:
2784                 $ref: '#/components/schemas/ErrorMessage'
2785           description: Conflict
2786         "500":
2787           content:
2788             application/json:
2789               example:
2790                 status: 500
2791                 message: Internal Server Error
2792                 details: Internal Server Error occurred
2793               schema:
2794                 $ref: '#/components/schemas/ErrorMessage'
2795           description: Internal Server Error
2796       summary: Get cps notification subscription
2797       tags:
2798       - cps-admin
2799     post:
2800       description: Create cps notification subscription
2801       operationId: createNotificationSubscription
2802       parameters:
2803       - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
2804         examples:
2805           subscription by dataspace xpath:
2806             value: "/dataspaces/dataspace[@name='dataspace01']"
2807           subscription by anchor xpath:
2808             value: "/dataspaces/dataspace[@name='dataspace01']/anchors/anchor[@name='anchor01']"
2809         in: query
2810         name: xpath
2811         required: true
2812         schema:
2813           default: /dataspaces
2814           type: string
2815       requestBody:
2816         content:
2817           application/json:
2818             examples:
2819               dataSample:
2820                 $ref: '#/components/examples/NotificationSubscriptionsDataSample'
2821             schema:
2822               type: object
2823         required: true
2824       responses:
2825         "201":
2826           description: Created without response body
2827         "400":
2828           content:
2829             application/json:
2830               example:
2831                 status: 400
2832                 message: Bad Request
2833                 details: The provided request is not valid
2834               schema:
2835                 $ref: '#/components/schemas/ErrorMessage'
2836           description: Bad Request
2837         "403":
2838           content:
2839             application/json:
2840               example:
2841                 status: 403
2842                 message: Request Forbidden
2843                 details: This request is forbidden
2844               schema:
2845                 $ref: '#/components/schemas/ErrorMessage'
2846           description: Forbidden
2847         "409":
2848           content:
2849             application/json:
2850               example:
2851                 status: 409
2852                 message: Conflicting request
2853                 details: The request cannot be processed as the resource is in use.
2854               schema:
2855                 $ref: '#/components/schemas/ErrorMessage'
2856           description: Conflict
2857         "500":
2858           content:
2859             application/json:
2860               example:
2861                 status: 500
2862                 message: Internal Server Error
2863                 details: Internal Server Error occurred
2864               schema:
2865                 $ref: '#/components/schemas/ErrorMessage'
2866           description: Internal Server Error
2867       summary: Create cps notification subscription
2868       tags:
2869       - cps-admin
2870 components:
2871   examples:
2872     dataSample:
2873       value:
2874         test:bookstore:
2875           bookstore-name: Chapters
2876           categories:
2877           - code: 1
2878             name: SciFi
2879           - books:
2880             - title: Book 1
2881               lang: N/A
2882               price: 11
2883               editions:
2884               - 2009
2885           - books:
2886             - title: Book 2
2887               lang: German
2888               price: 39
2889               editions:
2890               - 2007
2891               - 2013
2892               - 2021
2893           - code: 2
2894             name: kids
2895           - books:
2896             - title: Book 3
2897               lang: English
2898               price: 15
2899               editions:
2900               - 2010
2901     dataSampleXml:
2902       value: <stores xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <bookstore xmlns="org:onap:ccsdk:sample">
2903         <bookstore-name>Chapters</bookstore-name> <categories> <code>1</code> <name>SciFi</name>
2904         </categories> <categories> <books> <title>Book 1</title> <lang>N/A</lang>
2905         <price>11</price> <editions>2009</editions> </books> </categories> <categories>
2906         <books> <title>Book 2</title> <lang>German</lang> <price>39</price> <editions>2007</editions>
2907         <editions>2013</editions> <editions>2021</editions> </books> </categories>
2908         <categories> <code>2</code> <name>kids </name> <books> <title>Book 3</title>
2909         <lang>English</lang> <price>15</price> <editions>2010</editions> </books>
2910         </categories> </bookstore> </stores>
2911     dataSampleForV3:
2912       value:
2913         test:bookstore:
2914           bookstore-name: Chapters
2915           categories:
2916           - code: 1
2917             name: SciFi
2918             books:
2919             - title: Book 1
2920               lang: N/A
2921               price: 11
2922               editions:
2923               - 2009
2924             - title: Book 2
2925               lang: German
2926               price: 39
2927               editions:
2928               - 2007
2929               - 2013
2930               - 2021
2931           - code: 2
2932             name: kids
2933             books:
2934             - title: Book 3
2935               lang: English
2936               price: 15
2937               editions:
2938               - 2010
2939     dataSampleXmlForV3:
2940       value: <stores xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <bookstore xmlns="org:onap:ccsdk:sample">
2941         <bookstore-name>Chapters</bookstore-name> <categories> <code>1</code> <name>SciFi</name>
2942         <books> <title>Book 1</title> <lang>N/A</lang> <price>11</price> <editions>2009</editions>
2943         </books> <books> <title>Book 2</title> <lang>German</lang> <price>39</price>
2944         <editions>2007</editions> <editions>2013</editions> <editions>2021</editions>
2945         </books> </categories> <categories> <code>2</code> <name>kids</name> <books>
2946         <title>Book 3</title> <lang>English</lang> <price>15</price> <editions>2010</editions>
2947         </books> </categories> </bookstore> </stores>
2948     deltaReportSample:
2949       value:
2950       - action: create
2951         xpath: "/bookstore/categories/[@code=3]"
2952         target-data:
2953           code: "3,"
2954           name: kidz
2955       - action: remove
2956         xpath: "/bookstore/categories/[@code=1]"
2957         source-data:
2958           code: "1,"
2959           name: Fiction
2960       - action: replace
2961         xpath: "/bookstore/categories/[@code=2]"
2962         source-data:
2963           name: Funny
2964         target-data:
2965           name: Comic
2966     dataSampleAcrossAnchors:
2967       value:
2968       - anchorName: bookstore1
2969         dataNode:
2970           test:bookstore:
2971             bookstore-name: Chapters
2972             categories:
2973             - code: 1
2974               name: SciFi
2975             - code: 2
2976               name: kids
2977       - anchorName: bookstore2
2978         dataNode:
2979           test:bookstore:
2980             bookstore-name: Chapters
2981             categories:
2982             - code: 1
2983               name: SciFi
2984             - code: 2
2985               name: kids
2986     NotificationSubscriptionsDataSample:
2987       value:
2988         cps-notification-subscriptions:dataspaces:
2989           dataspace:
2990           - name: dataspace01
2991           - name: dataspace02
2992   parameters:
2993     dataspaceNameInQuery:
2994       description: dataspace-name
2995       in: query
2996       name: dataspace-name
2997       required: true
2998       schema:
2999         example: my-dataspace
3000         type: string
3001     apiVersionInPath:
3002       description: apiVersion
3003       in: path
3004       name: apiVersion
3005       required: true
3006       schema:
3007         default: v2
3008         enum:
3009         - v1
3010         - v2
3011         type: string
3012     dataspaceNameInPath:
3013       description: dataspace-name
3014       in: path
3015       name: dataspace-name
3016       required: true
3017       schema:
3018         example: my-dataspace
3019         type: string
3020     schemaSetNameInQuery:
3021       description: schema-set-name
3022       in: query
3023       name: schema-set-name
3024       required: true
3025       schema:
3026         example: my-schema-set
3027         type: string
3028     anchorNameInQuery:
3029       description: anchor-name
3030       in: query
3031       name: anchor-name
3032       required: true
3033       schema:
3034         example: my-anchor
3035         type: string
3036     anchorNameInPath:
3037       description: anchor-name
3038       in: path
3039       name: anchor-name
3040       required: true
3041       schema:
3042         example: my-anchor
3043         type: string
3044     schemaSetNameInPath:
3045       description: schema-set-name
3046       in: path
3047       name: schema-set-name
3048       required: true
3049       schema:
3050         example: my-schema-set
3051         type: string
3052     xpathInQuery:
3053       description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
3054       examples:
3055         container xpath:
3056           value: /shops/bookstore
3057         list attributes xpath:
3058           value: "/shops/bookstore/categories[@code=1]"
3059       in: query
3060       name: xpath
3061       required: false
3062       schema:
3063         default: /
3064         type: string
3065     includeDescendantsOptionInQuery:
3066       description: include-descendants
3067       in: query
3068       name: include-descendants
3069       required: false
3070       schema:
3071         default: false
3072         example: false
3073         type: boolean
3074     descendantsInQuery:
3075       description: "Number of descendants to query. Allowed values are 'none', 'all',\
3076         \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive number."
3077       in: query
3078       name: descendants
3079       required: false
3080       schema:
3081         default: none
3082         example: "3"
3083         type: string
3084     contentTypeInHeader:
3085       description: Content type in header
3086       in: header
3087       name: Content-Type
3088       required: false
3089       schema:
3090         default: application/json
3091         enum:
3092         - application/json
3093         - application/xml
3094         type: string
3095     dryRunInQuery:
3096       description: "Boolean flag to validate data, without persisting it. Default\
3097         \ value is false."
3098       in: query
3099       name: dry-run
3100       required: false
3101       schema:
3102         default: false
3103         example: false
3104         type: boolean
3105     observedTimestampInQuery:
3106       description: observed-timestamp
3107       in: query
3108       name: observed-timestamp
3109       required: false
3110       schema:
3111         example: 2021-03-21T00:10:34.030-0100
3112         type: string
3113     requiredXpathInQuery:
3114       description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
3115       examples:
3116         container xpath:
3117           value: /shops/bookstore
3118         list attributes xpath:
3119           value: "/shops/bookstore/categories[@code=1]"
3120       in: query
3121       name: xpath
3122       required: true
3123       schema:
3124         type: string
3125     sourceAnchorNameInPath:
3126       description: source-anchor-name
3127       in: path
3128       name: source-anchor-name
3129       required: true
3130       schema:
3131         example: my-anchor
3132         type: string
3133     targetAnchorNameInQuery:
3134       description: target-anchor-name
3135       in: query
3136       name: target-anchor-name
3137       required: true
3138       schema:
3139         example: my-anchor
3140         type: string
3141     groupDataNodesInQuery:
3142       description: Boolean flag to enable or disable grouping of data nodes. Enabling
3143         it generates a condensed delta report.
3144       in: query
3145       name: grouping-enabled
3146       required: false
3147       schema:
3148         default: false
3149         example: true
3150         type: boolean
3151     cpsPathInQuery:
3152       description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
3153       examples:
3154         container cps path:
3155           value: //bookstore
3156         list attributes cps path:
3157           value: "//categories[@code=1]"
3158       in: query
3159       name: cps-path
3160       required: false
3161       schema:
3162         default: /
3163         type: string
3164     pageIndexInQuery:
3165       description: page index for pagination over anchors. It must be greater then
3166         zero if provided.
3167       in: query
3168       name: pageIndex
3169       required: false
3170       schema:
3171         example: 1
3172         type: integer
3173     pageSizeInQuery:
3174       description: number of records (anchors) per page. It must be greater then zero
3175         if provided.
3176       in: query
3177       name: pageSize
3178       required: false
3179       schema:
3180         example: 10
3181         type: integer
3182     notificationSubscriptionXpathInQuery:
3183       description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
3184       examples:
3185         subscription by dataspace xpath:
3186           value: "/dataspaces/dataspace[@name='dataspace01']"
3187         subscription by anchor xpath:
3188           value: "/dataspaces/dataspace[@name='dataspace01']/anchors/anchor[@name='anchor01']"
3189       in: query
3190       name: xpath
3191       required: true
3192       schema:
3193         default: /dataspaces
3194         type: string
3195   responses:
3196     Created:
3197       content:
3198         application/json:
3199           schema:
3200             example: my-resource
3201             type: string
3202       description: Created
3203     BadRequest:
3204       content:
3205         application/json:
3206           example:
3207             status: 400
3208             message: Bad Request
3209             details: The provided request is not valid
3210           schema:
3211             $ref: '#/components/schemas/ErrorMessage'
3212       description: Bad Request
3213     Forbidden:
3214       content:
3215         application/json:
3216           example:
3217             status: 403
3218             message: Request Forbidden
3219             details: This request is forbidden
3220           schema:
3221             $ref: '#/components/schemas/ErrorMessage'
3222       description: Forbidden
3223     Conflict:
3224       content:
3225         application/json:
3226           example:
3227             status: 409
3228             message: Conflicting request
3229             details: The request cannot be processed as the resource is in use.
3230           schema:
3231             $ref: '#/components/schemas/ErrorMessage'
3232       description: Conflict
3233     InternalServerError:
3234       content:
3235         application/json:
3236           example:
3237             status: 500
3238             message: Internal Server Error
3239             details: Internal Server Error occurred
3240           schema:
3241             $ref: '#/components/schemas/ErrorMessage'
3242       description: Internal Server Error
3243     NoContent:
3244       content: {}
3245       description: No Content
3246     CreatedV2:
3247       description: Created without response body
3248     Ok:
3249       content:
3250         application/json:
3251           examples:
3252             dataSample:
3253               value: ""
3254           schema:
3255             type: object
3256       description: OK
3257     Unauthorized:
3258       content:
3259         application/json:
3260           example:
3261             status: 401
3262             message: Unauthorized request
3263             details: This request is unauthorized
3264           schema:
3265             $ref: '#/components/schemas/ErrorMessage'
3266       description: Unauthorized
3267   schemas:
3268     ErrorMessage:
3269       example:
3270         details: details
3271         message: message
3272         status: status
3273       properties:
3274         status:
3275           type: string
3276         message:
3277           type: string
3278         details:
3279           type: string
3280       title: Error
3281       type: object
3282     DataspaceDetails:
3283       example:
3284         name: my-dataspace
3285       properties:
3286         name:
3287           example: my-dataspace
3288           type: string
3289       title: Dataspace details by dataspace Name
3290       type: object
3291     AnchorDetails:
3292       example:
3293         schemaSetName: my-schema-set
3294         dataspaceName: my-dataspace
3295         name: my-anchor
3296       properties:
3297         name:
3298           example: my-anchor
3299           type: string
3300         dataspaceName:
3301           example: my-dataspace
3302           type: string
3303         schemaSetName:
3304           example: my-schema-set
3305           type: string
3306       title: Anchor details by anchor Name
3307       type: object
3308     MultipartFile:
3309       properties:
3310         file:
3311           description: multipartFile
3312           format: binary
3313           type: string
3314       required:
3315       - file
3316       type: object
3317     SchemaSetDetails:
3318       example:
3319         dataspaceName: my-dataspace
3320         name: my-schema-set
3321         moduleReferences:
3322         - name: my-module-reference-name
3323           namespace: my-module-reference-namespace
3324           revision: my-module-reference-revision
3325         - name: my-module-reference-name
3326           namespace: my-module-reference-namespace
3327           revision: my-module-reference-revision
3328       properties:
3329         dataspaceName:
3330           example: my-dataspace
3331           type: string
3332         moduleReferences:
3333           items:
3334             $ref: '#/components/schemas/ModuleReferences'
3335           type: array
3336         name:
3337           example: my-schema-set
3338           type: string
3339       required:
3340       - moduleReferences
3341       title: Schema set details by dataspace and schemasetName
3342       type: object
3343     ModuleReferences:
3344       example:
3345         name: my-module-reference-name
3346         namespace: my-module-reference-namespace
3347         revision: my-module-reference-revision
3348       properties:
3349         name:
3350           example: my-module-reference-name
3351           type: string
3352         namespace:
3353           example: my-module-reference-namespace
3354           type: string
3355         revision:
3356           example: my-module-reference-revision
3357           type: string
3358       title: Module reference object
3359       type: object
3360     NotificationSubscriptionsDataSample: {}
3361     getDeltaByDataspaceAnchorAndPayload_request:
3362       properties:
3363         targetDataAsJsonFile:
3364           example: "{$ref=components.yml#/components/schemas/TargetDataAsJsonFile}"
3365           format: binary
3366           type: string
3367         yangResourceFile:
3368           example: "{$ref=components.yml#/components/schemas/MultipartFile}"
3369           format: binary
3370           type: string
3371       required:
3372       - targetDataAsJsonFile
3373       type: object