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

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