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

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