main/src/main/resources/openapi/openapi.yaml

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