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