policy-management/src/main/resources/openapi/openapi.yaml

   1 #  ============LICENSE_START=======================================================
   2 #  Copyright (C) 2023 Nordix Foundation
   3 #  ================================================================================
   4 #  Licensed under the Apache License, Version 2.0 (the "License");
   5 #  you may not use this file except in compliance with the License.
   6 #  You may obtain a copy of the License at
   7 #
   8 #        http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #  Unless required by applicable law or agreed to in writing, software
  11 #  distributed under the License is distributed on an "AS IS" BASIS,
  12 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #  See the License for the specific language governing permissions and
  14 #  limitations under the License.
  15 #
  16 #  SPDX-License-Identifier: Apache-2.0
  17 #  ============LICENSE_END=========================================================
  18 openapi: 3.0.3
  19 info:
  20   title: "PDP-D Telemetry Services Documentation"
  21   description: PDP-D Telemetry Services
  22   version: Swagger Server
  23 servers:
  24 - url: http://{drools-ip}:9696/policy/pdp/engine
  25   variables:
  26     drools-ip:
  27       default: 0.0.0.0
  28 tags:
  29 - name: pdp-d-telemetry
  30   description: Drools PDP Telemetry Operations
  31 - name: pdp-d-lifecycle
  32   description: Drools PDP Lifecycle Operations
  33 - name: pdp-d-legacy
  34   description: Drools PDP Legacy Operations
  35 paths:
  36   /swagger:
  37     get:
  38       tags:
  39         - pdp-d-telemetry
  40       summary: Retrieves the json swagger documentation
  41       description: Lifecycle Group
  42       operationId: swagger
  43       responses:
  44         200:
  45           description: successful operation
  46           content:
  47             application/json:
  48               schema:
  49                 $ref: '#/components/schemas/Response'
  50             application/yaml:
  51               schema:
  52                 $ref: '#/components/schemas/Response'
  53         404:
  54           description: resource not found
  55           content: {}
  56         501:
  57           description: swagger.json file not found
  58           content: {}
  59   /lifecycle/group:
  60     get:
  61       tags:
  62         - pdp-d-lifecycle
  63       summary: Retrieves the Lifecycle group
  64       description: Lifecycle Group
  65       operationId: group
  66       responses:
  67         200:
  68           description: successful operation
  69           content:
  70             application/json:
  71               schema:
  72                 $ref: '#/components/schemas/Response'
  73             application/yaml:
  74               schema:
  75                 $ref: '#/components/schemas/Response'
  76   /lifecycle/group/{group}:
  77     put:
  78       tags:
  79         - pdp-d-lifecycle
  80       summary: Updates the Lifecycle group
  81       description: Lifecycle Group
  82       operationId: updateGroup
  83       parameters:
  84       - name: group
  85         in: path
  86         description: Group
  87         required: true
  88         schema:
  89           type: string
  90       responses:
  91         200:
  92           description: successful operation
  93           content:
  94             application/json:
  95               schema:
  96                 $ref: '#/components/schemas/Response'
  97             application/yaml:
  98               schema:
  99                 $ref: '#/components/schemas/Response'
 100   /lifecycle/status/interval:
 101     get:
 102       tags:
 103         - pdp-d-lifecycle
 104       summary: Retrieves the Lifecycle Status Timer Interval in seconds
 105       description: Lifecycle Status Timer Interval in seconds
 106       operationId: updateStatusTimer
 107       responses:
 108         200:
 109           description: successful operation
 110           content:
 111             application/json:
 112               schema:
 113                 $ref: '#/components/schemas/Response'
 114             application/yaml:
 115               schema:
 116                 $ref: '#/components/schemas/Response'
 117   /lifecycle/status/interval/{timeout}:
 118     put:
 119       tags:
 120         - pdp-d-lifecycle
 121       summary: Updates the Lifecycle Status Timer Interval in seconds
 122       description: Lifecycle Status Timer Interval in seconds
 123       operationId: statusTimer
 124       parameters:
 125       - name: timeout
 126         in: path
 127         description: timeout
 128         required: true
 129         schema:
 130           type: integer
 131           format: int64
 132       responses:
 133         200:
 134           description: successful operation
 135           content:
 136             application/json:
 137               schema:
 138                 $ref: '#/components/schemas/Response'
 139             application/yaml:
 140               schema:
 141                 $ref: '#/components/schemas/Response'
 142   /lifecycle/policyTypes:
 143     get:
 144       tags:
 145         - pdp-d-lifecycle
 146       summary: List of supported policy types
 147       description: Lifecycle Policy Types
 148       operationId: policyTypes
 149       responses:
 150         200:
 151           description: successful operation
 152           content:
 153             application/json:
 154               schema:
 155                 $ref: '#/components/schemas/Response'
 156             application/yaml:
 157               schema:
 158                 $ref: '#/components/schemas/Response'
 159   /lifecycle/policies:
 160     get:
 161       tags:
 162         - pdp-d-lifecycle
 163       summary: List of policies
 164       operationId: policies
 165       responses:
 166         200:
 167           description: successful operation
 168           content:
 169             application/json:
 170               schema:
 171                 $ref: '#/components/schemas/Response'
 172             application/yaml:
 173               schema:
 174                 $ref: '#/components/schemas/Response'
 175     post:
 176       tags:
 177         - pdp-d-lifecycle
 178       summary: Deploy a policy
 179       operationId: deployTrackedPolicy
 180       requestBody:
 181         description: Tosca Policy
 182         content:
 183           application/json:
 184             schema:
 185               type: string
 186           application/yaml:
 187             schema:
 188               type: string
 189         required: true
 190       responses:
 191         200:
 192           description: successful operation
 193           content:
 194             application/json:
 195               schema:
 196                 $ref: '#/components/schemas/Response'
 197             application/yaml:
 198               schema:
 199                 $ref: '#/components/schemas/Response'
 200       x-codegen-request-body-name: body
 201   /lifecycle/policyTypes/{policyType}/{policyTypeVersion}:
 202     get:
 203       tags:
 204         - pdp-d-lifecycle
 205       summary: Entities associated with a policy type
 206       description: Lifecycle policy Types
 207       operationId: policyType
 208       parameters:
 209       - name: policyType
 210         in: path
 211         description: Policy Type
 212         required: true
 213         schema:
 214           type: string
 215       - name: policyTypeVersion
 216         in: path
 217         description: Policy Type Version
 218         required: true
 219         schema:
 220           type: string
 221       responses:
 222         200:
 223           description: successful operation
 224           content:
 225             application/json:
 226               schema:
 227                 $ref: '#/components/schemas/Response'
 228             application/yaml:
 229               schema:
 230                 $ref: '#/components/schemas/Response'
 231   /lifecycle/policies/operations:
 232     get:
 233       tags:
 234         - pdp-d-lifecycle
 235       summary: Gets Policy Operations
 236       operationId: policiesOperations
 237       responses:
 238         200:
 239           description: successful operation
 240           content:
 241             application/json:
 242               schema:
 243                 $ref: '#/components/schemas/Response'
 244             application/yaml:
 245               schema:
 246                 $ref: '#/components/schemas/Response'
 247   /lifecycle/policies/operations/deployment:
 248     post:
 249       tags:
 250         - pdp-d-lifecycle
 251       summary: Deploys a policy
 252       description: Deploys a policy
 253       operationId: deployOperation
 254       requestBody:
 255         description: Tosca Policy
 256         content:
 257           application/json:
 258             schema:
 259               type: string
 260           application/yaml:
 261             schema:
 262               type: string
 263         required: true
 264       responses:
 265         200:
 266           description: successful operation
 267           content:
 268             application/json:
 269               schema:
 270                 $ref: '#/components/schemas/Response'
 271             application/yaml:
 272               schema:
 273                 $ref: '#/components/schemas/Response'
 274       x-codegen-request-body-name: body
 275   /lifecycle/policies/operations/undeployment:
 276     post:
 277       tags:
 278         - pdp-d-lifecycle
 279       summary: Undeploys a policy
 280       operationId: undeployOperation
 281       requestBody:
 282         description: Tosca Policy
 283         content:
 284           application/json:
 285             schema:
 286               type: string
 287           application/yaml:
 288             schema:
 289               type: string
 290         required: true
 291       responses:
 292         200:
 293           description: successful operation
 294           content:
 295             application/json:
 296               schema:
 297                 $ref: '#/components/schemas/Response'
 298             application/yaml:
 299               schema:
 300                 $ref: '#/components/schemas/Response'
 301       x-codegen-request-body-name: body
 302   /lifecycle/policies/operations/validation:
 303     post:
 304       tags:
 305         - pdp-d-lifecycle
 306       summary: Validates a policy
 307       operationId: validateOperation
 308       requestBody:
 309         description: Tosca Policy
 310         content:
 311           application/json:
 312             schema:
 313               type: string
 314           application/yaml:
 315             schema:
 316               type: string
 317         required: true
 318       responses:
 319         200:
 320           description: successful operation
 321           content:
 322             application/json:
 323               schema:
 324                 $ref: '#/components/schemas/Response'
 325             application/yaml:
 326               schema:
 327                 $ref: '#/components/schemas/Response'
 328       x-codegen-request-body-name: body
 329   /lifecycle/policies/{policyName}/{policyVersion}:
 330     get:
 331       tags:
 332         - pdp-d-lifecycle
 333       summary: Retrieves a policy
 334       operationId: policy
 335       parameters:
 336       - name: policyName
 337         in: path
 338         description: Policy Name
 339         required: true
 340         schema:
 341           type: string
 342       - name: policyVersion
 343         in: path
 344         description: Policy Version
 345         required: true
 346         schema:
 347           type: string
 348       responses:
 349         200:
 350           description: successful operation
 351           content:
 352             application/json:
 353               schema:
 354                 $ref: '#/components/schemas/Response'
 355             application/yaml:
 356               schema:
 357                 $ref: '#/components/schemas/Response'
 358     delete:
 359       tags:
 360         - pdp-d-lifecycle
 361       summary: Deletes a Lifecycle tracked policy
 362       operationId: undeployPolicy
 363       parameters:
 364       - name: policyName
 365         in: path
 366         description: Policy
 367         required: true
 368         schema:
 369           type: string
 370       - name: policyVersion
 371         in: path
 372         description: Policy Version
 373         required: true
 374         schema:
 375           type: string
 376       responses:
 377         200:
 378           description: successful operation
 379           content:
 380             application/json:
 381               schema:
 382                 $ref: '#/components/schemas/Response'
 383             application/yaml:
 384               schema:
 385                 $ref: '#/components/schemas/Response'
 386   /lifecycle/state:
 387     get:
 388       tags:
 389         - pdp-d-lifecycle
 390       summary: Retrieves the Lifecycle state
 391       description: Lifecycle State
 392       operationId: state
 393       responses:
 394         200:
 395           description: successful operation
 396           content:
 397             application/json:
 398               schema:
 399                 $ref: '#/components/schemas/Response'
 400             application/yaml:
 401               schema:
 402                 $ref: '#/components/schemas/Response'
 403   /lifecycle/state/{state}:
 404     put:
 405       tags:
 406         - pdp-d-lifecycle
 407       summary: updates the Lifecycle state
 408       description: Lifecycle State
 409       operationId: updateState
 410       parameters:
 411       - name: state
 412         in: path
 413         description: state
 414         required: true
 415         schema:
 416           type: string
 417       responses:
 418         200:
 419           description: successful operation
 420           content:
 421             application/json:
 422               schema:
 423                 $ref: '#/components/schemas/Response'
 424             application/yaml:
 425               schema:
 426                 $ref: '#/components/schemas/Response'
 427   /lifecycle/subgroup/{subgroup}:
 428     put:
 429       tags:
 430         - pdp-d-lifecycle
 431       summary: Retrieves the Lifecycle subgroup
 432       description: Lifecycle Subgroup
 433       operationId: subgroup
 434       parameters:
 435       - name: subgroup
 436         in: path
 437         description: Subgroup
 438         required: true
 439         schema:
 440           type: string
 441       responses:
 442         200:
 443           description: successful operation
 444           content:
 445             application/json:
 446               schema:
 447                 $ref: '#/components/schemas/Response'
 448             application/yaml:
 449               schema:
 450                 $ref: '#/components/schemas/Response'
 451   /lifecycle/subgroup:
 452     get:
 453       tags:
 454         - pdp-d-lifecycle
 455       summary: Retrieves the Lifecycle subgroup
 456       description: Lifecycle Subgroup
 457       operationId: subgroup_1
 458       responses:
 459         200:
 460           description: successful operation
 461           content:
 462             application/json:
 463               schema:
 464                 $ref: '#/components/schemas/Response'
 465             application/yaml:
 466               schema:
 467                 $ref: '#/components/schemas/Response'
 468   /lifecycle/statistics:
 469     get:
 470       tags:
 471         - pdp-d-lifecycle
 472       summary: Gets Policy Statistics
 473       operationId: stats
 474       responses:
 475         200:
 476           description: successful operation
 477           content:
 478             application/json:
 479               schema:
 480                 $ref: '#/components/schemas/Response'
 481             application/yaml:
 482               schema:
 483                 $ref: '#/components/schemas/Response'
 484   /lifecycle/properties:
 485     get:
 486       tags:
 487         - pdp-d-lifecycle
 488       summary: Retrieves the Lifecycle properties
 489       description: Lifecycle Properties
 490       operationId: propertiesLifecycle
 491       responses:
 492         200:
 493           description: successful operation
 494           content:
 495             application/json:
 496               schema:
 497                 $ref: '#/components/schemas/Response'
 498             application/yaml:
 499               schema:
 500                 $ref: '#/components/schemas/Response'
 501   /lifecycle/topic/sink:
 502     get:
 503       tags:
 504         - pdp-d-lifecycle
 505       summary: Retrieves the Lifecycle topic sink
 506       description: Lifecycle Topic Sink
 507       operationId: sink
 508       responses:
 509         200:
 510           description: successful operation
 511           content:
 512             application/json:
 513               schema:
 514                 $ref: '#/components/schemas/Response'
 515             application/yaml:
 516               schema:
 517                 $ref: '#/components/schemas/Response'
 518   /lifecycle/topic/source:
 519     get:
 520       tags:
 521         - pdp-d-lifecycle
 522       summary: Retrieves the Lifecycle topic source
 523       description: Lifecycle Topic Source
 524       operationId: sourceLifecycle
 525       responses:
 526         200:
 527           description: successful operation
 528           content:
 529             application/json:
 530               schema:
 531                 $ref: '#/components/schemas/Response'
 532             application/yaml:
 533               schema:
 534                 $ref: '#/components/schemas/Response'
 535   /:
 536     get:
 537       tags:
 538         - pdp-d-telemetry
 539       summary: Retrieves the Engine Operational Status
 540       description: Top-level abstraction.  Provides a global view of resources
 541       operationId: engine
 542       responses:
 543         200:
 544           description: successful operation
 545           content:
 546             application/json:
 547               schema:
 548                 $ref: '#/components/schemas/Response'
 549             application/yaml:
 550               schema:
 551                 $ref: '#/components/schemas/Response'
 552     delete:
 553       tags:
 554         - pdp-d-telemetry
 555       summary: Shuts down the Engine
 556       description: Deleting the engine, the top-level abstraction, equivalenty shuts
 557         it down
 558       operationId: engineShutdown
 559       responses:
 560         200:
 561           description: successful operation
 562           content:
 563             application/json:
 564               schema:
 565                 $ref: '#/components/schemas/Response'
 566             application/yaml:
 567               schema:
 568                 $ref: '#/components/schemas/Response'
 569   /features:
 570     get:
 571       tags:
 572         - pdp-d-telemetry
 573       summary: Engine Features
 574       description: Provides the list of loaded features using the PolicyEngineFeatureAPI
 575       operationId: engineFeatures
 576       responses:
 577         200:
 578           description: successful operation
 579           content:
 580             application/json:
 581               schema:
 582                 $ref: '#/components/schemas/Response'
 583             application/yaml:
 584               schema:
 585                 $ref: '#/components/schemas/Response'
 586   /features/{featureName}:
 587     get:
 588       tags:
 589         - pdp-d-telemetry
 590       summary: Engine Feature
 591       description: Provides Details for a given feature Engine Provider
 592       operationId: engineFeature
 593       parameters:
 594       - name: featureName
 595         in: path
 596         description: Feature Name
 597         required: true
 598         schema:
 599           type: string
 600       responses:
 601         200:
 602           description: successful operation
 603           content:
 604             application/json:
 605               schema:
 606                 $ref: '#/components/schemas/Response'
 607             application/yaml:
 608               schema:
 609                 $ref: '#/components/schemas/Response'
 610         404:
 611           description: The feature cannot be found
 612           content: {}
 613   /features/inventory:
 614     get:
 615       tags:
 616         - pdp-d-telemetry
 617       summary: Engine Detailed Feature Inventory
 618       description: Provides detailed list of loaded features using the PolicyEngineFeatureAPI
 619       operationId: engineFeaturesInventory
 620       responses:
 621         200:
 622           description: successful operation
 623           content:
 624             application/json:
 625               schema:
 626                 $ref: '#/components/schemas/Response'
 627             application/yaml:
 628               schema:
 629                 $ref: '#/components/schemas/Response'
 630   /inputs:
 631     get:
 632       tags:
 633         - pdp-d-telemetry
 634       summary: Engine Input Ports
 635       description: List of input ports
 636       operationId: engineInputs
 637       responses:
 638         200:
 639           description: successful operation
 640           content:
 641             application/json:
 642               schema:
 643                 $ref: '#/components/schemas/Response'
 644             application/yaml:
 645               schema:
 646                 $ref: '#/components/schemas/Response'
 647   /inputs/configuration:
 648     post:
 649       tags:
 650         - pdp-d-telemetry
 651       summary: Engine Input Configuration Requests
 652       description: Feeds a configuration request input into the Engine
 653       operationId: engineUpdate
 654       requestBody:
 655         description: Configuration to apply
 656         content:
 657           application/json:
 658             schema:
 659               $ref: '#/components/schemas/PdpdConfiguration'
 660           application/yaml:
 661             schema:
 662               $ref: '#/components/schemas/PdpdConfiguration'
 663         required: true
 664       responses:
 665         200:
 666           description: successful operation
 667           content:
 668             application/json:
 669               schema:
 670                 $ref: '#/components/schemas/Response'
 671             application/yaml:
 672               schema:
 673                 $ref: '#/components/schemas/Response'
 674         406:
 675           description: The configuration request cannot be honored
 676           content: {}
 677       x-codegen-request-body-name: body
 678   /environment/{envProperty}:
 679     get:
 680       tags:
 681         - pdp-d-telemetry
 682       summary: Gets an environment variable
 683       operationId: engineEnvironmentProperty
 684       parameters:
 685       - name: envProperty
 686         in: path
 687         description: Environment Property
 688         required: true
 689         schema:
 690           type: string
 691       responses:
 692         200:
 693           description: successful operation
 694           content:
 695             application/json:
 696               schema:
 697                 $ref: '#/components/schemas/Response'
 698             application/yaml:
 699               schema:
 700                 $ref: '#/components/schemas/Response'
 701     put:
 702       tags:
 703         - pdp-d-telemetry
 704       summary: Adds a new environment value to the engine
 705       operationId: engineEnvironmentAdd
 706       parameters:
 707       - name: envProperty
 708         in: path
 709         description: Environment Property
 710         required: true
 711         schema:
 712           type: string
 713       requestBody:
 714         description: Environment Value
 715         content:
 716           text/plain:
 717             schema:
 718               type: string
 719         required: true
 720       responses:
 721         200:
 722           description: successful operation
 723           content:
 724             application/json:
 725               schema:
 726                 $ref: '#/components/schemas/Response'
 727             application/yaml:
 728               schema:
 729                 $ref: '#/components/schemas/Response'
 730       x-codegen-request-body-name: body
 731   /environment:
 732     get:
 733       tags:
 734         - pdp-d-telemetry
 735       summary: Engine Environment Properties
 736       description: Installation and OS environment properties used by the engine
 737       operationId: engineEnvironment
 738       responses:
 739         200:
 740           description: successful operation
 741           content:
 742             application/json:
 743               schema:
 744                 $ref: '#/components/schemas/Response'
 745             application/yaml:
 746               schema:
 747                 $ref: '#/components/schemas/Response'
 748   /switches:
 749     get:
 750       tags:
 751         - pdp-d-telemetry
 752       summary: Engine Control Switches
 753       description: List of the Engine Control Switches
 754       operationId: engineSwitches
 755       responses:
 756         200:
 757           description: successful operation
 758           content:
 759             application/json:
 760               schema:
 761                 $ref: '#/components/schemas/Response'
 762             application/yaml:
 763               schema:
 764                 $ref: '#/components/schemas/Response'
 765   /switches/activation:
 766     put:
 767       tags:
 768         - pdp-d-telemetry
 769       summary: Switches on the Engine Activation Switch
 770       description: Turns on Activation Switch on the Engine. This order entails that
 771         the engine and controllers are unlocked and started
 772       operationId: engineActivation
 773       responses:
 774         200:
 775           description: successful operation
 776           content:
 777             application/json:
 778               schema:
 779                 $ref: '#/components/schemas/Response'
 780             application/yaml:
 781               schema:
 782                 $ref: '#/components/schemas/Response'
 783     delete:
 784       tags:
 785         - pdp-d-telemetry
 786       summary: Switches off Engine Activation Switch
 787       description: Turns off the Activation Switch on the Engine. This order entails
 788         that the engine and controllers are locked (with the exception of those resources
 789         defined as unmanaged)
 790       operationId: engineDeactivation
 791       responses:
 792         200:
 793           description: successful operation
 794           content:
 795             application/json:
 796               schema:
 797                 $ref: '#/components/schemas/Response'
 798             application/yaml:
 799               schema:
 800                 $ref: '#/components/schemas/Response'
 801   /switches/lock:
 802     put:
 803       tags:
 804         - pdp-d-telemetry
 805       summary: Switches on the Engine Lock Control
 806       description: This switch locks all the engine resources as a whole, except those
 807         that are defined unmanaged
 808       operationId: engineLock
 809       responses:
 810         200:
 811           description: successful operation
 812           content:
 813             application/json:
 814               schema:
 815                 $ref: '#/components/schemas/Response'
 816             application/yaml:
 817               schema:
 818                 $ref: '#/components/schemas/Response'
 819         406:
 820           description: The system is an administrative state that prevents this request
 821             to be fulfilled
 822           content: {}
 823     delete:
 824       tags:
 825         - pdp-d-telemetry
 826       summary: Switches off the Lock control
 827       description: This switch locks all the engine resources as a whole, except those
 828         that are defined unmanaged
 829       operationId: engineUnlock
 830       responses:
 831         200:
 832           description: successful operation
 833           content:
 834             application/json:
 835               schema:
 836                 $ref: '#/components/schemas/Response'
 837             application/yaml:
 838               schema:
 839                 $ref: '#/components/schemas/Response'
 840         406:
 841           description: The system is an administrative state that prevents this request
 842             to be fulfilled
 843           content: {}
 844   /properties:
 845     get:
 846       tags:
 847         - pdp-d-telemetry
 848       summary: Engine Configuration Properties
 849       description: Used for booststrapping the engine
 850       operationId: engineProperties
 851       responses:
 852         200:
 853           description: successful operation
 854           content:
 855             application/json:
 856               schema:
 857                 $ref: '#/components/schemas/Response'
 858             application/yaml:
 859               schema:
 860                 $ref: '#/components/schemas/Response'
 861   /controllers:
 862     get:
 863       tags:
 864         - pdp-d-telemetry
 865       summary: Lists the Policy Controllers Names
 866       description: Unique Policy Controller Identifiers
 867       operationId: controllers
 868       responses:
 869         200:
 870           description: successful operation
 871           content:
 872             application/json:
 873               schema:
 874                 $ref: '#/components/schemas/Response'
 875             application/yaml:
 876               schema:
 877                 $ref: '#/components/schemas/Response'
 878     post:
 879       tags:
 880         - pdp-d-telemetry
 881       summary: Creates and starts a new Policy Controller
 882       description: Controller creation based on properties
 883       operationId: controllerAdd
 884       requestBody:
 885         description: Configuration Properties to apply
 886         content:
 887           application/json:
 888             schema:
 889               $ref: '#/components/schemas/Properties'
 890           application/yaml:
 891             schema:
 892               $ref: '#/components/schemas/Properties'
 893         required: true
 894       responses:
 895         200:
 896           description: successful operation
 897           content:
 898             application/json:
 899               schema:
 900                 $ref: '#/components/schemas/Response'
 901             application/yaml:
 902               schema:
 903                 $ref: '#/components/schemas/Response'
 904         201:
 905           description: The controller has been succesfully created and started
 906           content: {}
 907         206:
 908           description: The controller has been created but cannot be started
 909           content: {}
 910         304:
 911           description: The controller already exists
 912           content: {}
 913         400:
 914           description: Invalid configuration information has been provided
 915           content: {}
 916         406:
 917           description: The administrative state of the system prevents it from processing
 918             this request
 919           content: {}
 920       x-codegen-request-body-name: body
 921   /controllers/features:
 922     get:
 923       tags:
 924         - pdp-d-telemetry
 925       summary: Lists of Feature Providers Identifiers
 926       description: Unique Policy Controller Identifiers
 927       operationId: controllerFeatures
 928       responses:
 929         200:
 930           description: successful operation
 931           content:
 932             application/json:
 933               schema:
 934                 $ref: '#/components/schemas/Response'
 935             application/yaml:
 936               schema:
 937                 $ref: '#/components/schemas/Response'
 938   /controllers/features/{featureName}:
 939     get:
 940       tags:
 941         - pdp-d-telemetry
 942       summary: Controller Feature
 943       description: Provides Details for a given Policy Controller feature provider
 944       operationId: controllerFeature
 945       parameters:
 946       - name: featureName
 947         in: path
 948         description: Feature Name
 949         required: true
 950         schema:
 951           type: string
 952       responses:
 953         200:
 954           description: successful operation
 955           content:
 956             application/json:
 957               schema:
 958                 $ref: '#/components/schemas/Response'
 959             application/yaml:
 960               schema:
 961                 $ref: '#/components/schemas/Response'
 962         404:
 963           description: The feature cannot be found
 964           content: {}
 965   /controllers/inventory:
 966     get:
 967       tags:
 968         - pdp-d-telemetry
 969       summary: Lists the Policy Controllers
 970       description: Detailed list of Policy Controllers
 971       operationId: controllerInventory
 972       responses:
 973         200:
 974           description: successful operation
 975           content:
 976             application/json:
 977               schema:
 978                 $ref: '#/components/schemas/Response'
 979             application/yaml:
 980               schema:
 981                 $ref: '#/components/schemas/Response'
 982   /controllers/features/inventory:
 983     get:
 984       tags:
 985         - pdp-d-telemetry
 986       summary: Detailed Controllers Feature Inventory
 987       description: Provides detailed list of loaded features using the PolicyControllerFeatureAPI
 988       operationId: controllerFeaturesInventory
 989       responses:
 990         200:
 991           description: successful operation
 992           content:
 993             application/json:
 994               schema:
 995                 $ref: '#/components/schemas/Response'
 996             application/yaml:
 997               schema:
 998                 $ref: '#/components/schemas/Response'
 999   /controllers/{controller}:
1000     get:
1001       tags:
1002         - pdp-d-telemetry
1003       summary: Retrieves a Policy Controller
1004       description: A Policy Controller is a concrete drools application abstraction.  It
1005         aggregates networking, drools, and other resources,as provides operational
1006         controls over drools applications
1007       operationId: controller
1008       parameters:
1009       - name: controller
1010         in: path
1011         description: Policy Controller Name
1012         required: true
1013         schema:
1014           type: string
1015       responses:
1016         200:
1017           description: successful operation
1018           content:
1019             application/json:
1020               schema:
1021                 $ref: '#/components/schemas/Response'
1022             application/yaml:
1023               schema:
1024                 $ref: '#/components/schemas/Response'
1025         404:
1026           description: The controller cannot be found
1027           content: {}
1028         406:
1029           description: The system is an administrative state that prevents this request
1030             to be fulfilled
1031           content: {}
1032     delete:
1033       tags:
1034         - pdp-d-telemetry
1035       summary: Deletes a Policy Controller
1036       description: A Policy Controller is a concrete drools application abstraction.  It
1037         aggregates networking, drools, and other resources,as provides operational
1038         controls over drools applications
1039       operationId: controllerDelete
1040       parameters:
1041       - name: controller
1042         in: path
1043         description: Policy Controller Name
1044         required: true
1045         schema:
1046           type: string
1047       responses:
1048         200:
1049           description: successful operation
1050           content:
1051             application/json:
1052               schema:
1053                 $ref: '#/components/schemas/Response'
1054             application/yaml:
1055               schema:
1056                 $ref: '#/components/schemas/Response'
1057         404:
1058           description: The controller cannot be found
1059           content: {}
1060         406:
1061           description: The system is an administrative state that prevents this request
1062             to be fulfilled
1063           content: {}
1064         500:
1065           description: A problem has occurred while deleting the Policy Controller
1066           content: {}
1067   /controllers/{controller}/inputs:
1068     get:
1069       tags:
1070         - pdp-d-telemetry
1071       summary: Policy Controller Input Ports
1072       description: List of input ports
1073       operationId: controllerInputs
1074       parameters:
1075       - name: controller
1076         in: path
1077         description: Policy Controller Name
1078         required: true
1079         schema:
1080           type: string
1081       responses:
1082         200:
1083           description: successful operation
1084           content:
1085             application/json:
1086               schema:
1087                 $ref: '#/components/schemas/Response'
1088             application/yaml:
1089               schema:
1090                 $ref: '#/components/schemas/Response'
1091   /controllers/{controller}/inputs/configuration:
1092     post:
1093       tags:
1094         - pdp-d-telemetry
1095       summary: Policy Controller Input Configuration Requests
1096       description: Feeds a configuration request input into the given Policy Controller
1097       operationId: controllerUpdate
1098       parameters:
1099       - name: controller
1100         in: path
1101         description: Policy Controller Name
1102         required: true
1103         schema:
1104           type: string
1105       requestBody:
1106         description: Configuration to apply
1107         content:
1108           application/json:
1109             schema:
1110               $ref: '#/components/schemas/ControllerConfiguration'
1111           application/yaml:
1112             schema:
1113               $ref: '#/components/schemas/ControllerConfiguration'
1114         required: true
1115       responses:
1116         200:
1117           description: successful operation
1118           content:
1119             application/json:
1120               schema:
1121                 $ref: '#/components/schemas/Response'
1122             application/yaml:
1123               schema:
1124                 $ref: '#/components/schemas/Response'
1125         400:
1126           description: The configuration request is invalid
1127           content: {}
1128         406:
1129           description: The configuration request cannot be honored
1130           content: {}
1131       x-codegen-request-body-name: body
1132   /controllers/{controller}/switches:
1133     get:
1134       tags:
1135         - pdp-d-telemetry
1136       summary: Policy Controller Switches
1137       description: List of the Policy Controller Switches
1138       operationId: controllerSwitches
1139       parameters:
1140       - name: controller
1141         in: path
1142         description: Policy Controller Name
1143         required: true
1144         schema:
1145           type: string
1146       responses:
1147         200:
1148           description: successful operation
1149           content:
1150             application/json:
1151               schema:
1152                 $ref: '#/components/schemas/Response'
1153             application/yaml:
1154               schema:
1155                 $ref: '#/components/schemas/Response'
1156   /controllers/{controller}/switches/lock:
1157     put:
1158       tags:
1159         - pdp-d-telemetry
1160       summary: Switches on the Policy Controller Lock Control
1161       description: This action on the switch locks the Policy Controller
1162       operationId: controllerLock
1163       parameters:
1164       - name: controller
1165         in: path
1166         description: Policy Controller Name
1167         required: true
1168         schema:
1169           type: string
1170       responses:
1171         200:
1172           description: successful operation
1173           content:
1174             application/json:
1175               schema:
1176                 $ref: '#/components/schemas/Response'
1177             application/yaml:
1178               schema:
1179                 $ref: '#/components/schemas/Response'
1180         406:
1181           description: The system is an administrative state that prevents this request
1182             to be fulfilled
1183           content: {}
1184     delete:
1185       tags:
1186         - pdp-d-telemetry
1187       summary: Switches off the Policy Controller Lock Control
1188       description: This action on the switch unlocks the Policy Controller
1189       operationId: controllerUnlock
1190       parameters:
1191       - name: controller
1192         in: path
1193         description: Policy Controller Name
1194         required: true
1195         schema:
1196           type: string
1197       responses:
1198         200:
1199           description: successful operation
1200           content:
1201             application/json:
1202               schema:
1203                 $ref: '#/components/schemas/Response'
1204             application/yaml:
1205               schema:
1206                 $ref: '#/components/schemas/Response'
1207         406:
1208           description: The system is an administrative state that prevents this request
1209             to be fulfilled
1210           content: {}
1211   /controllers/{controller}/drools/facts/{session}/{factType}:
1212     get:
1213       tags:
1214         - pdp-d-telemetry
1215       summary: Retrieves fact objects of a given type in the drools working memoryfor
1216         a given controller and session
1217       description: The fact types are the classnames of the objects inserted in the
1218         drools working memory
1219       operationId: droolsFacts
1220       parameters:
1221       - name: count
1222         in: query
1223         description: Fact count
1224         schema:
1225           type: boolean
1226           default: false
1227       - name: controller
1228         in: path
1229         description: Policy Controller Name
1230         required: true
1231         schema:
1232           type: string
1233       - name: session
1234         in: path
1235         description: Drools Session Name
1236         required: true
1237         schema:
1238           type: string
1239       - name: factType
1240         in: path
1241         description: Drools Fact Type
1242         required: true
1243         schema:
1244           type: string
1245       responses:
1246         200:
1247           description: successful operation
1248           content:
1249             application/json:
1250               schema:
1251                 $ref: '#/components/schemas/Response'
1252             application/yaml:
1253               schema:
1254                 $ref: '#/components/schemas/Response'
1255         404:
1256           description: The controller, session, or fact type cannot be found
1257           content: {}
1258         406:
1259           description: The system is an administrative state that prevents this request
1260             to be fulfilled
1261           content: {}
1262     delete:
1263       tags:
1264         - pdp-d-telemetry
1265       summary: Deletes all the fact objects of a given type from the drools working
1266         memoryfor a given controller and session.   The objects retracted from the
1267         working memory are provided in the response.
1268       description: The fact types are the classnames of the objects inserted in the
1269         drools working memory
1270       operationId: droolsFactsDelete_1
1271       parameters:
1272       - name: controller
1273         in: path
1274         description: Policy Controller Name
1275         required: true
1276         schema:
1277           type: string
1278       - name: session
1279         in: path
1280         description: Drools Session Name
1281         required: true
1282         schema:
1283           type: string
1284       - name: factType
1285         in: path
1286         description: Drools Fact Type
1287         required: true
1288         schema:
1289           type: string
1290       responses:
1291         200:
1292           description: successful operation
1293           content:
1294             application/json:
1295               schema:
1296                 $ref: '#/components/schemas/Response'
1297             application/yaml:
1298               schema:
1299                 $ref: '#/components/schemas/Response'
1300         404:
1301           description: The controller, session, or fact type, cannot be found
1302           content: {}
1303         406:
1304           description: The system is an administrative state that prevents this request
1305             to be fulfilled
1306           content: {}
1307         500:
1308           description: A server error has occurred processing this request
1309           content: {}
1310   /controllers/{controller}/drools/facts/{session}:
1311     get:
1312       tags:
1313         - pdp-d-telemetry
1314       summary: Retrieves Fact Types (classnames) for a given controller and its count
1315       description: The fact types are the classnames of the objects inserted in the
1316         drools working memory
1317       operationId: droolsFacts_1
1318       parameters:
1319       - name: controller
1320         in: path
1321         description: Policy Controller Name
1322         required: true
1323         schema:
1324           type: string
1325       - name: session
1326         in: path
1327         description: Drools Session Name
1328         required: true
1329         schema:
1330           type: string
1331       responses:
1332         200:
1333           description: successful operation
1334           content:
1335             application/json:
1336               schema:
1337                 $ref: '#/components/schemas/Response'
1338             application/yaml:
1339               schema:
1340                 $ref: '#/components/schemas/Response'
1341         404:
1342           description: The controller or session cannot be found
1343           content: {}
1344         406:
1345           description: The system is an administrative state that prevents this request
1346             to be fulfilled
1347           content: {}
1348   /controllers/{controller}/drools/facts:
1349     get:
1350       tags:
1351         - pdp-d-telemetry
1352       summary: Retrieves Facts Summary information for a given controller
1353       description: Provides the session names, and a count of fact object in the drools
1354         working memory
1355       operationId: droolsFacts_2
1356       parameters:
1357       - name: controller
1358         in: path
1359         description: Policy Controller Name
1360         required: true
1361         schema:
1362           type: string
1363       responses:
1364         200:
1365           description: successful operation
1366           content:
1367             application/json:
1368               schema:
1369                 $ref: '#/components/schemas/Response'
1370             application/yaml:
1371               schema:
1372                 $ref: '#/components/schemas/Response'
1373         404:
1374           description: The controller cannot be found
1375           content: {}
1376         406:
1377           description: The system is an administrative state that prevents this request
1378             to be fulfilled
1379           content: {}
1380   /controllers/{controller}/drools/facts/{session}/{query}/{queriedEntity}:
1381     get:
1382       tags:
1383         - pdp-d-telemetry
1384       summary: Gets all the fact objects returned by a DRL query with no parameters
1385         from the drools working memoryfor a given controller and session
1386       description: The DRL query must be defined in the DRL file
1387       operationId: droolsFacts_3
1388       parameters:
1389       - name: count
1390         in: query
1391         description: Fact count
1392         schema:
1393           type: boolean
1394           default: false
1395       - name: controller
1396         in: path
1397         description: Policy Controller Name
1398         required: true
1399         schema:
1400           type: string
1401       - name: session
1402         in: path
1403         description: Drools Session Name
1404         required: true
1405         schema:
1406           type: string
1407       - name: query
1408         in: path
1409         description: Query Name Present in DRL
1410         required: true
1411         schema:
1412           type: string
1413       - name: queriedEntity
1414         in: path
1415         description: Query Identifier Present in the DRL Query
1416         required: true
1417         schema:
1418           type: string
1419       responses:
1420         200:
1421           description: successful operation
1422           content:
1423             application/json:
1424               schema:
1425                 $ref: '#/components/schemas/Response'
1426             application/yaml:
1427               schema:
1428                 $ref: '#/components/schemas/Response'
1429         404:
1430           description: The controller, session, or query information, cannot be found
1431           content: {}
1432         406:
1433           description: The system is an administrative state that prevents this request
1434             to be fulfilled
1435           content: {}
1436         500:
1437           description: A server error has occurred processing this request
1438           content: {}
1439     post:
1440       tags:
1441         - pdp-d-telemetry
1442       summary: Gets all the fact objects returned by a DRL query with parameters from
1443         the drools working memoryfor a given controller and session
1444       description: The DRL query with parameters must be defined in the DRL file
1445       operationId: droolsFacts_4
1446       parameters:
1447       - name: controller
1448         in: path
1449         description: Policy Controller Name
1450         required: true
1451         schema:
1452           type: string
1453       - name: session
1454         in: path
1455         description: Drools Session Name
1456         required: true
1457         schema:
1458           type: string
1459       - name: query
1460         in: path
1461         description: Query Name Present in DRL
1462         required: true
1463         schema:
1464           type: string
1465       - name: queriedEntity
1466         in: path
1467         description: Query Identifier Present in the DRL Query
1468         required: true
1469         schema:
1470           type: string
1471       requestBody:
1472         description: Query Parameter Values to pass in the DRL Query
1473         content:
1474           application/json:
1475             schema:
1476               type: array
1477               items:
1478                 type: object
1479                 properties: {}
1480           application/yaml:
1481             schema:
1482               type: array
1483               items:
1484                 type: object
1485                 properties: {}
1486         required: false
1487       responses:
1488         200:
1489           description: successful operation
1490           content:
1491             application/json:
1492               schema:
1493                 $ref: '#/components/schemas/Response'
1494             application/yaml:
1495               schema:
1496                 $ref: '#/components/schemas/Response'
1497         404:
1498           description: The controller, session, or query information, cannot be found
1499           content: {}
1500         406:
1501           description: The system is an administrative state that prevents this request
1502             to be fulfilled
1503           content: {}
1504         500:
1505           description: A server error has occurred processing this request
1506           content: {}
1507       x-codegen-request-body-name: body
1508     delete:
1509       tags:
1510         - pdp-d-telemetry
1511       summary: Deletes all the fact objects returned by a DRL query with parameters
1512         from the drools working memory for a given controller and session
1513       description: The DRL query with parameters must be defined in the DRL file
1514       operationId: droolsFactsDelete
1515       parameters:
1516       - name: controller
1517         in: path
1518         description: Policy Controller Name
1519         required: true
1520         schema:
1521           type: string
1522       - name: session
1523         in: path
1524         description: Drools Session Name
1525         required: true
1526         schema:
1527           type: string
1528       - name: query
1529         in: path
1530         description: Query Name Present in DRL
1531         required: true
1532         schema:
1533           type: string
1534       - name: queriedEntity
1535         in: path
1536         description: Query Identifier Present in the DRL Query
1537         required: true
1538         schema:
1539           type: string
1540       responses:
1541         200:
1542           description: successful operation
1543           content:
1544             application/json:
1545               schema:
1546                 $ref: '#/components/schemas/Response'
1547             application/yaml:
1548               schema:
1549                 $ref: '#/components/schemas/Response'
1550         404:
1551           description: The controller, session, or query information, cannot be found
1552           content: {}
1553         406:
1554           description: The system is an administrative state that prevents this request
1555             to be fulfilled
1556           content: {}
1557         500:
1558           description: A server error has occurred processing this request
1559           content: {}
1560       x-codegen-request-body-name: body
1561   /controllers/{controller}/decoders:
1562     get:
1563       tags:
1564         - pdp-d-telemetry
1565       summary: Gets all the decoders used by a controller
1566       description: A Policy Controller uses decoders to deserialize incoming network
1567         messages from subscribed network topics into specific (fact) objects. The
1568         deserialized (fact) object will typically be inserted in the drools working  memory
1569         of the controlled drools application.
1570       operationId: decoders
1571       parameters:
1572       - name: controller
1573         in: path
1574         description: Policy Controller Name
1575         required: true
1576         schema:
1577           type: string
1578       responses:
1579         200:
1580           description: successful operation
1581           content:
1582             application/json:
1583               schema:
1584                 $ref: '#/components/schemas/Response'
1585             application/yaml:
1586               schema:
1587                 $ref: '#/components/schemas/Response'
1588         404:
1589           description: The controller cannot be found
1590           content: {}
1591         406:
1592           description: The system is an administrative state that prevents this request
1593             to be fulfilled
1594           content: {}
1595   /controllers/{controller}/decoders/filters:
1596     get:
1597       tags:
1598         - pdp-d-telemetry
1599       summary: Gets all the filters used by a controller
1600       description: A Policy Controller uses decoders to deserialize incoming network
1601         messages from subscribed network topics into specific (fact) objects. The
1602         deserialized (fact) object will typically be inserted in the drools working  memory
1603         of the controlled drools application.Acceptance filters are used to filter
1604         out undesired network messages for the given controller
1605       operationId: decoderFilters
1606       parameters:
1607       - name: controller
1608         in: path
1609         description: Policy Controller Name
1610         required: true
1611         schema:
1612           type: string
1613       responses:
1614         200:
1615           description: successful operation
1616           content:
1617             application/json:
1618               schema:
1619                 $ref: '#/components/schemas/Response'
1620             application/yaml:
1621               schema:
1622                 $ref: '#/components/schemas/Response'
1623         404:
1624           description: The controller cannot be found
1625           content: {}
1626         406:
1627           description: The system is an administrative state that prevents this request
1628             to be fulfilled
1629           content: {}
1630   /controllers/{controller}/decoders/{topic}:
1631     get:
1632       tags:
1633         - pdp-d-telemetry
1634       summary: Gets all the decoders in use by a controller for a networked topic
1635       description: A Policy Controller uses decoders to deserialize incoming network
1636         messages from subscribed network topics into specific (fact) objects. The
1637         deserialized (fact) object will typically be inserted in the drools working  memory
1638         of the controlled drools application.
1639       operationId: decoder
1640       parameters:
1641       - name: controller
1642         in: path
1643         description: Policy Controller Name
1644         required: true
1645         schema:
1646           type: string
1647       - name: topic
1648         in: path
1649         description: Networked Topic Name
1650         required: true
1651         schema:
1652           type: string
1653       responses:
1654         200:
1655           description: successful operation
1656           content:
1657             application/json:
1658               schema:
1659                 $ref: '#/components/schemas/Response'
1660             application/yaml:
1661               schema:
1662                 $ref: '#/components/schemas/Response'
1663         404:
1664           description: The controller or topic cannot be found
1665           content: {}
1666         406:
1667           description: The system is an administrative state that prevents this request
1668             to be fulfilled
1669           content: {}
1670     post:
1671       tags:
1672         - pdp-d-telemetry
1673       summary: Decodes a string into a fact object, and encodes it back into a string
1674       description: Tests the decode/encode functions of a controller
1675       operationId: decode
1676       parameters:
1677       - name: controller
1678         in: path
1679         description: Policy Controller Name
1680         required: true
1681         schema:
1682           type: string
1683       - name: topic
1684         in: path
1685         description: Topic Name
1686         required: true
1687         schema:
1688           type: string
1689       requestBody:
1690         description: JSON String to decode
1691         content:
1692           text/plain:
1693             schema:
1694               type: string
1695         required: true
1696       responses:
1697         200:
1698           description: successful operation
1699           content:
1700             application/json:
1701               schema:
1702                 $ref: '#/components/schemas/Response'
1703             application/yaml:
1704               schema:
1705                 $ref: '#/components/schemas/Response'
1706         400:
1707           description: Bad input has been provided
1708           content: {}
1709         404:
1710           description: The controller cannot be found
1711           content: {}
1712         406:
1713           description: The system is an administrative state that prevents this request
1714             to be fulfilled
1715           content: {}
1716       x-codegen-request-body-name: body
1717   /controllers/{controller}/decoders/{topic}/filters/{factType}:
1718     get:
1719       tags:
1720         - pdp-d-telemetry
1721       summary: Gets all filters attached to decoders for a given subscribed networked
1722         topic and fact type
1723       description: Decoders are associated with networked topics. A Policy Controller
1724         manages multiple topics and therefore its attached decoders. A Policy Controller
1725         uses filters to further specify the fact mapping.  Filters are applied on
1726         a per fact type (classname).
1727       operationId: decoderFilter_1
1728       parameters:
1729       - name: controller
1730         in: path
1731         description: Policy Controller Name
1732         required: true
1733         schema:
1734           type: string
1735       - name: topic
1736         in: path
1737         description: Networked Topic Name
1738         required: true
1739         schema:
1740           type: string
1741       - name: factType
1742         in: path
1743         description: Fact Type
1744         required: true
1745         schema:
1746           type: string
1747       responses:
1748         200:
1749           description: successful operation
1750           content:
1751             application/json:
1752               schema:
1753                 $ref: '#/components/schemas/Response'
1754             application/yaml:
1755               schema:
1756                 $ref: '#/components/schemas/Response'
1757         404:
1758           description: The controller, topic, or fact type cannot be found
1759           content: {}
1760         406:
1761           description: The system is an administrative state that prevents this request
1762             to be fulfilled
1763           content: {}
1764     put:
1765       tags:
1766         - pdp-d-telemetry
1767       summary: Attaches filters to the decoder for a given networked topic and fact
1768         type
1769       description: Decoders are associated with networked topics. A Policy Controller
1770         manages multiple topics and therefore its attached decoders. A Policy Controller
1771         uses filters to further specify the fact mapping.  Filters are applied on
1772         a per fact type (classname).
1773       operationId: decoderFilter
1774       parameters:
1775       - name: controller
1776         in: path
1777         description: Policy Controller Name
1778         required: true
1779         schema:
1780           type: string
1781       - name: topic
1782         in: path
1783         description: Topic Name
1784         required: true
1785         schema:
1786           type: string
1787       - name: factType
1788         in: path
1789         description: Fact Type
1790         required: true
1791         schema:
1792           type: string
1793       requestBody:
1794         description: Configuration Filter
1795         content:
1796           application/json:
1797             schema:
1798               $ref: '#/components/schemas/JsonProtocolFilter'
1799           application/yaml:
1800             schema:
1801               $ref: '#/components/schemas/JsonProtocolFilter'
1802         required: true
1803       responses:
1804         200:
1805           description: successful operation
1806           content:
1807             application/json:
1808               schema:
1809                 $ref: '#/components/schemas/Response'
1810             application/yaml:
1811               schema:
1812                 $ref: '#/components/schemas/Response'
1813         404:
1814           description: The controller, topic, fact type, cannot be found, or a filter
1815             has not been provided
1816           content: {}
1817         406:
1818           description: The system is an administrative state that prevents this request
1819             to be fulfilled
1820           content: {}
1821       x-codegen-request-body-name: body
1822   /controllers/{controller}/decoders/{topic}/filters:
1823     get:
1824       tags:
1825         - pdp-d-telemetry
1826       summary: Gets all filters attached to decoders for a given networked topic in
1827         use by a controller
1828       description: A Policy Controller uses decoders to deserialize incoming network
1829         messages from subscribed network topics into specific (fact) objects. The
1830         deserialized (fact) object will typically be inserted in the drools working  memory
1831         of the controlled drools application.Acceptance filters are used to filter
1832         out undesired network messages for the given controller
1833       operationId: decoderFilter_2
1834       parameters:
1835       - name: controller
1836         in: path
1837         description: Policy Controller Name
1838         required: true
1839         schema:
1840           type: string
1841       - name: topic
1842         in: path
1843         description: Networked Topic Name
1844         required: true
1845         schema:
1846           type: string
1847       responses:
1848         200:
1849           description: successful operation
1850           content:
1851             application/json:
1852               schema:
1853                 $ref: '#/components/schemas/Response'
1854             application/yaml:
1855               schema:
1856                 $ref: '#/components/schemas/Response'
1857         404:
1858           description: The controller or topic cannot be found
1859           content: {}
1860         406:
1861           description: The system is an administrative state that prevents this request
1862             to be fulfilled
1863           content: {}
1864   /controllers/{controller}/decoders/{topic}/filters/{factType}/rule:
1865     get:
1866       tags:
1867         - pdp-d-telemetry
1868       summary: Gets the filter rule attached to a topic decoder of a controller
1869       description: 'Decoders are associated with networked topics. A Policy Controller
1870         manages multiple topics and therefore its attached decoders. A Policy Controller
1871         uses filters to further specify the fact mapping.  Filters are applied on
1872         a per fact type using a jsonpath expression rule. '
1873       operationId: decoderFilterRules
1874       parameters:
1875       - name: controller
1876         in: path
1877         description: Policy Controller Name
1878         required: true
1879         schema:
1880           type: string
1881       - name: topic
1882         in: path
1883         description: Topic Name
1884         required: true
1885         schema:
1886           type: string
1887       - name: factType
1888         in: path
1889         description: Fact Type
1890         required: true
1891         schema:
1892           type: string
1893       responses:
1894         200:
1895           description: successful operation
1896           content:
1897             application/json:
1898               schema:
1899                 $ref: '#/components/schemas/Response'
1900             application/yaml:
1901               schema:
1902                 $ref: '#/components/schemas/Response'
1903         404:
1904           description: The controller, topic, or fact type cannot be found
1905           content: {}
1906         406:
1907           description: The system is an administrative state that prevents this request
1908             to be fulfilled
1909           content: {}
1910     put:
1911       tags:
1912         - pdp-d-telemetry
1913       summary: Places a new filter rule in a topic decoder
1914       description: 'Decoders are associated with networked topics. A Policy Controller
1915         manages multiple topics and therefore its attached decoders. A Policy Controller
1916         uses filters to further specify the fact mapping.  Filters are applied on
1917         a per fact type using a jsonpath expression rule. '
1918       operationId: decoderFilterRule
1919       parameters:
1920       - name: controller
1921         in: path
1922         description: Policy Controller Name
1923         required: true
1924         schema:
1925           type: string
1926       - name: topic
1927         in: path
1928         description: Topic Name
1929         required: true
1930         schema:
1931           type: string
1932       - name: factType
1933         in: path
1934         description: Fact Type
1935         required: true
1936         schema:
1937           type: string
1938       requestBody:
1939         description: JsonPath filter expression
1940         content:
1941           application/json:
1942             schema:
1943               type: string
1944           application/yaml:
1945             schema:
1946               type: string
1947         required: true
1948       responses:
1949         200:
1950           description: successful operation
1951           content:
1952             application/json:
1953               schema:
1954                 $ref: '#/components/schemas/Response'
1955             application/yaml:
1956               schema:
1957                 $ref: '#/components/schemas/Response'
1958         404:
1959           description: The controller, topic, or fact type cannot be found
1960           content: {}
1961         406:
1962           description: The system is an administrative state that prevents this request
1963             to be fulfilled
1964           content: {}
1965       x-codegen-request-body-name: body
1966     delete:
1967       tags:
1968         - pdp-d-telemetry
1969       summary: Deletes the filter rule attached to a topic decoder of a controller
1970       description: 'Decoders are associated with networked topics. A Policy Controller
1971         manages multiple topics and therefore its attached decoders. A Policy Controller
1972         uses filters to further specify the fact mapping.  Filters are applied on
1973         a per fact type using a jsonpath expression rule. '
1974       operationId: decoderFilterRuleDelete
1975       parameters:
1976       - name: controller
1977         in: path
1978         description: Policy Controller Name
1979         required: true
1980         schema:
1981           type: string
1982       - name: topic
1983         in: path
1984         description: Topic Name
1985         required: true
1986         schema:
1987           type: string
1988       - name: factType
1989         in: path
1990         description: Fact Type
1991         required: true
1992         schema:
1993           type: string
1994       responses:
1995         200:
1996           description: successful operation
1997           content:
1998             application/json:
1999               schema:
2000                 $ref: '#/components/schemas/Response'
2001             application/yaml:
2002               schema:
2003                 $ref: '#/components/schemas/Response'
2004         404:
2005           description: The controller, topic, or fact type cannot be found
2006           content: {}
2007         406:
2008           description: The system is an administrative state that prevents this request
2009             to be fulfilled
2010           content: {}
2011   /controllers/{controller}/encoders:
2012     get:
2013       tags:
2014         - pdp-d-telemetry
2015       summary: Retrieves the encoder filters of a controller
2016       description: The encoders serializes a fact object, typically for network transmission
2017       operationId: encoderFilters
2018       parameters:
2019       - name: controller
2020         in: path
2021         description: Policy Controller Name
2022         required: true
2023         schema:
2024           type: string
2025       responses:
2026         200:
2027           description: successful operation
2028           content:
2029             application/json:
2030               schema:
2031                 $ref: '#/components/schemas/Response'
2032             application/yaml:
2033               schema:
2034                 $ref: '#/components/schemas/Response'
2035         400:
2036           description: Bad input has been provided
2037           content: {}
2038         406:
2039           description: The system is an administrative state that prevents this request
2040             to be fulfilled
2041           content: {}
2042   /controllers/{controller}/drools:
2043     get:
2044       tags:
2045         - pdp-d-telemetry
2046       summary: Retrieves the Drools Controller subcomponent of the Policy Controller
2047       description: The Drools Controller provides an abstraction over the Drools subsystem
2048       operationId: drools
2049       parameters:
2050       - name: controller
2051         in: path
2052         description: Policy Controller Name
2053         required: true
2054         schema:
2055           type: string
2056       responses:
2057         200:
2058           description: successful operation
2059           content:
2060             application/json:
2061               schema:
2062                 $ref: '#/components/schemas/Response'
2063             application/yaml:
2064               schema:
2065                 $ref: '#/components/schemas/Response'
2066         404:
2067           description: The controller cannot be found
2068           content: {}
2069         406:
2070           description: The system is an administrative state that prevents this request
2071             to be fulfilled
2072           content: {}
2073   /controllers/{controller}/properties:
2074     get:
2075       tags:
2076         - pdp-d-telemetry
2077       summary: Retrieves the configuration properties of a Policy Controller
2078       description: Configuration resources used by the controller if Properties format
2079       operationId: controllerProperties
2080       parameters:
2081       - name: controller
2082         in: path
2083         description: Policy Controller Name
2084         required: true
2085         schema:
2086           type: string
2087       responses:
2088         200:
2089           description: successful operation
2090           content:
2091             application/json:
2092               schema:
2093                 $ref: '#/components/schemas/Response'
2094             application/yaml:
2095               schema:
2096                 $ref: '#/components/schemas/Response'
2097         404:
2098           description: The controller cannot be found
2099           content: {}
2100         406:
2101           description: The system is an administrative state that prevents this request
2102             to be fulfilled
2103           content: {}
2104   /controllers/tools/coders/decoders/filters/rule:
2105     post:
2106       tags:
2107         - pdp-d-telemetry
2108       summary: Produces a Decoder Rule Filter in a format that the Policy Controller
2109         can understand
2110       description: The result can be used with other APIs to attach a filter to a
2111         decoder
2112       operationId: rules
2113       requestBody:
2114         description: JsonPath expression
2115         content:
2116           application/json:
2117             schema:
2118               type: string
2119           application/yaml:
2120             schema:
2121               type: string
2122         required: true
2123       responses:
2124         200:
2125           description: successful operation
2126           content:
2127             application/json:
2128               schema:
2129                 $ref: '#/components/schemas/Response'
2130             application/yaml:
2131               schema:
2132                 $ref: '#/components/schemas/Response'
2133       x-codegen-request-body-name: body
2134   /tools/uuid:
2135     get:
2136       tags:
2137         - pdp-d-telemetry
2138       summary: Produces an UUID
2139       description: UUID generation utility
2140       operationId: uuid
2141       responses:
2142         200:
2143           description: successful operation
2144           content:
2145             application/json:
2146               schema:
2147                 $ref: '#/components/schemas/Response'
2148             application/yaml:
2149               schema:
2150                 $ref: '#/components/schemas/Response'
2151   /tools/loggers/{logger}/{level}:
2152     put:
2153       tags:
2154         - pdp-d-telemetry
2155       summary: sets the logger level
2156       description: Please use the SLF4J logger levels
2157       operationId: loggerName
2158       parameters:
2159       - name: logger
2160         in: path
2161         description: Logger Name
2162         required: true
2163         schema:
2164           type: string
2165       - name: level
2166         in: path
2167         description: Logger Level
2168         required: true
2169         schema:
2170           type: string
2171       responses:
2172         200:
2173           description: successful operation
2174           content:
2175             application/json:
2176               schema:
2177                 $ref: '#/components/schemas/Response'
2178             application/yaml:
2179               schema:
2180                 $ref: '#/components/schemas/Response'
2181         404:
2182           description: logger not found
2183           content: {}
2184         500:
2185           description: logging misconfiguration
2186           content: {}
2187   /tools/loggers/{logger}:
2188     get:
2189       tags:
2190         - pdp-d-telemetry
2191       summary: logging level of a logger
2192       operationId: loggerName_1
2193       parameters:
2194       - name: logger
2195         in: path
2196         description: Logger Name
2197         required: true
2198         schema:
2199           type: string
2200       responses:
2201         200:
2202           description: successful operation
2203           content:
2204             application/json:
2205               schema:
2206                 $ref: '#/components/schemas/Response'
2207             application/yaml:
2208               schema:
2209                 $ref: '#/components/schemas/Response'
2210         404:
2211           description: logger not found
2212           content: {}
2213         500:
2214           description: logging misconfiguration
2215           content: {}
2216   /tools/loggers:
2217     get:
2218       tags:
2219         - pdp-d-telemetry
2220       summary: all active loggers
2221       operationId: loggers
2222       responses:
2223         200:
2224           description: successful operation
2225           content:
2226             application/json:
2227               schema:
2228                 $ref: '#/components/schemas/Response'
2229             application/yaml:
2230               schema:
2231                 $ref: '#/components/schemas/Response'
2232         500:
2233           description: logging misconfiguration
2234           content: {}
2235   /topics:
2236     get:
2237       tags:
2238         - pdp-d-telemetry
2239       summary: Retrieves the managed topics
2240       description: Network Topics Aggregation
2241       operationId: topics
2242       responses:
2243         200:
2244           description: successful operation
2245           content:
2246             application/json:
2247               schema:
2248                 $ref: '#/components/schemas/Response'
2249             application/yaml:
2250               schema:
2251                 $ref: '#/components/schemas/Response'
2252   /topics/sources:
2253     get:
2254       tags:
2255         - pdp-d-telemetry
2256       summary: Retrieves the managed topic sources
2257       description: Network Topic Sources Agregation
2258       operationId: sources
2259       responses:
2260         200:
2261           description: successful operation
2262           content:
2263             application/json:
2264               schema:
2265                 $ref: '#/components/schemas/Response'
2266             application/yaml:
2267               schema:
2268                 $ref: '#/components/schemas/Response'
2269   /topics/sinks:
2270     get:
2271       tags:
2272         - pdp-d-telemetry
2273       summary: Retrieves the managed topic sinks
2274       description: Network Topic Sinks Agregation
2275       operationId: sinks
2276       responses:
2277         200:
2278           description: successful operation
2279           content:
2280             application/json:
2281               schema:
2282                 $ref: '#/components/schemas/Response'
2283             application/yaml:
2284               schema:
2285                 $ref: '#/components/schemas/Response'
2286   /topics/switches:
2287     get:
2288       tags:
2289         - pdp-d-telemetry
2290       summary: Topics Control Switches
2291       description: List of the Topic Control Switches
2292       operationId: topicSwitches
2293       responses:
2294         200:
2295           description: successful operation
2296           content:
2297             application/json:
2298               schema:
2299                 $ref: '#/components/schemas/Response'
2300             application/yaml:
2301               schema:
2302                 $ref: '#/components/schemas/Response'
2303   /topics/switches/lock:
2304     put:
2305       tags:
2306         - pdp-d-telemetry
2307       summary: Locks all the managed topics
2308       description: The operation affects all managed sources and sinks
2309       operationId: topicsLock
2310       responses:
2311         200:
2312           description: successful operation
2313           content:
2314             application/json:
2315               schema:
2316                 $ref: '#/components/schemas/Response'
2317             application/yaml:
2318               schema:
2319                 $ref: '#/components/schemas/Response'
2320         406:
2321           description: The system is an administrative state that prevents this request
2322             to be fulfilled
2323           content: {}
2324     delete:
2325       tags:
2326         - pdp-d-telemetry
2327       summary: Unlocks all the managed topics
2328       description: The operation affects all managed sources and sinks
2329       operationId: topicsUnlock
2330       responses:
2331         200:
2332           description: successful operation
2333           content:
2334             application/json:
2335               schema:
2336                 $ref: '#/components/schemas/Response'
2337             application/yaml:
2338               schema:
2339                 $ref: '#/components/schemas/Response'
2340         406:
2341           description: The system is an administrative state that prevents this request
2342             to be fulfilled
2343           content: {}
2344   /topics/sources/{comm}:
2345     get:
2346       tags:
2347         - pdp-d-telemetry
2348       summary: Retrieves managed topic sources
2349       description: Sources for a communication infrastructure
2350       operationId: commSources
2351       parameters:
2352       - name: comm
2353         in: path
2354         description: Communication Mechanism
2355         required: true
2356         schema:
2357           pattern: ueb|dmaap|noop
2358           type: string
2359       responses:
2360         200:
2361           description: successful operation
2362           content:
2363             application/json:
2364               schema:
2365                 $ref: '#/components/schemas/Response'
2366             application/yaml:
2367               schema:
2368                 $ref: '#/components/schemas/Response'
2369   /topics/sinks/{comm}:
2370     get:
2371       tags:
2372         - pdp-d-telemetry
2373       summary: Retrieves managed topic sinks
2374       description: Communication Infrastructure Sinks
2375       operationId: commSinks
2376       parameters:
2377       - name: comm
2378         in: path
2379         description: Communication Mechanism
2380         required: true
2381         schema:
2382           pattern: ueb|dmaap|noop
2383           type: string
2384       responses:
2385         200:
2386           description: successful operation
2387           content:
2388             application/json:
2389               schema:
2390                 $ref: '#/components/schemas/Response'
2391             application/yaml:
2392               schema:
2393                 $ref: '#/components/schemas/Response'
2394   /topics/sources/{comm}/{topic}:
2395     get:
2396       tags:
2397         - pdp-d-telemetry
2398       summary: Retrieves a managed topic source
2399       description: This is an Network Communication Endpoint source of messages for
2400         the Engine
2401       operationId: sourceTopic
2402       parameters:
2403       - name: comm
2404         in: path
2405         description: Communication Mechanism
2406         required: true
2407         schema:
2408           pattern: ueb|dmaap|noop
2409           type: string
2410       - name: topic
2411         in: path
2412         description: Topic Name
2413         required: true
2414         schema:
2415           type: string
2416       responses:
2417         200:
2418           description: successful operation
2419           content:
2420             application/json:
2421               schema:
2422                 $ref: '#/components/schemas/Response'
2423             application/yaml:
2424               schema:
2425                 $ref: '#/components/schemas/Response'
2426   /topics/sinks/{comm}/{topic}:
2427     get:
2428       tags:
2429         - pdp-d-telemetry
2430       summary: Retrieves a managed topic sink
2431       description: This is a Network Communicaton Endpoint destination of messages
2432         from the Engine
2433       operationId: sinkTopic
2434       parameters:
2435       - name: comm
2436         in: path
2437         description: Communication Mechanism
2438         required: true
2439         schema:
2440           pattern: ueb|dmaap|noop
2441           type: string
2442       - name: topic
2443         in: path
2444         description: Topic Name
2445         required: true
2446         schema:
2447           type: string
2448       responses:
2449         200:
2450           description: successful operation
2451           content:
2452             application/json:
2453               schema:
2454                 $ref: '#/components/schemas/Response'
2455             application/yaml:
2456               schema:
2457                 $ref: '#/components/schemas/Response'
2458   /topics/sources/{comm}/{topic}/events:
2459     get:
2460       tags:
2461         - pdp-d-telemetry
2462       summary: Retrieves the latest events received by an UEB topic
2463       description: This is a Network Communicaton Endpoint source of messages for
2464         the Engine
2465       operationId: sourceEvents
2466       parameters:
2467       - name: comm
2468         in: path
2469         description: Communication Mechanism
2470         required: true
2471         schema:
2472           pattern: ueb|dmaap|noop
2473           type: string
2474       - name: topic
2475         in: path
2476         description: Topic Name
2477         required: true
2478         schema:
2479           type: string
2480       responses:
2481         200:
2482           description: successful operation
2483           content:
2484             application/json:
2485               schema:
2486                 $ref: '#/components/schemas/Response'
2487             application/yaml:
2488               schema:
2489                 $ref: '#/components/schemas/Response'
2490     put:
2491       tags:
2492         - pdp-d-telemetry
2493       summary: Offers an event to a topic for internal processing by the engine
2494       description: The offered event is treated as it was incoming from the network
2495       operationId: commEventOffer
2496       parameters:
2497       - name: comm
2498         in: path
2499         description: Communication Mechanism
2500         required: true
2501         schema:
2502           pattern: ueb|dmaap|noop
2503           type: string
2504       - name: topic
2505         in: path
2506         description: Topic Name
2507         required: true
2508         schema:
2509           type: string
2510       requestBody:
2511         description: Network Message
2512         content:
2513           text/plain:
2514             schema:
2515               type: string
2516         required: true
2517       responses:
2518         200:
2519           description: successful operation
2520           content:
2521             application/json:
2522               schema:
2523                 $ref: '#/components/schemas/Response'
2524             application/yaml:
2525               schema:
2526                 $ref: '#/components/schemas/Response'
2527         404:
2528           description: The topic information cannot be found
2529           content: {}
2530         406:
2531           description: The system is an administrative state that prevents this request
2532             to be fulfilled
2533           content: {}
2534         500:
2535           description: A server error has occurred processing this request
2536           content: {}
2537       x-codegen-request-body-name: body
2538   /topics/sinks/{comm}/{topic}/events:
2539     get:
2540       tags:
2541         - pdp-d-telemetry
2542       summary: Retrieves the latest events received by an UEB topic
2543       description: This is a Network Communicaton Endpoint source of messages for
2544         the Engine
2545       operationId: sinkEvents
2546       parameters:
2547       - name: comm
2548         in: path
2549         description: Communication Mechanism
2550         required: true
2551         schema:
2552           pattern: ueb|dmaap|noop
2553           type: string
2554       - name: topic
2555         in: path
2556         description: Topic Name
2557         required: true
2558         schema:
2559           type: string
2560       responses:
2561         200:
2562           description: successful operation
2563           content:
2564             application/json:
2565               schema:
2566                 $ref: '#/components/schemas/Response'
2567             application/yaml:
2568               schema:
2569                 $ref: '#/components/schemas/Response'
2570   /topics/sinks/{comm}/{topic}/switches/lock:
2571     put:
2572       tags:
2573         - pdp-d-telemetry
2574       summary: Locks a topic sink
2575       operationId: commSinkTopicLock
2576       parameters:
2577       - name: comm
2578         in: path
2579         description: Communication Mechanism
2580         required: true
2581         schema:
2582           pattern: ueb|dmaap|noop
2583           type: string
2584       - name: topic
2585         in: path
2586         description: Topic Name
2587         required: true
2588         schema:
2589           type: string
2590       responses:
2591         200:
2592           description: successful operation
2593           content:
2594             application/json:
2595               schema:
2596                 $ref: '#/components/schemas/Response'
2597             application/yaml:
2598               schema:
2599                 $ref: '#/components/schemas/Response'
2600         406:
2601           description: The system is an administrative state that prevents this request
2602             to be fulfilled
2603           content: {}
2604     delete:
2605       tags:
2606         - pdp-d-telemetry
2607       summary: Unlocks a topic sink
2608       operationId: commSinkTopicUnlock
2609       parameters:
2610       - name: comm
2611         in: path
2612         description: Communication Mechanism
2613         required: true
2614         schema:
2615           pattern: ueb|dmaap|noop
2616           type: string
2617       - name: topic
2618         in: path
2619         description: Topic Name
2620         required: true
2621         schema:
2622           type: string
2623       responses:
2624         200:
2625           description: successful operation
2626           content:
2627             application/json:
2628               schema:
2629                 $ref: '#/components/schemas/Response'
2630             application/yaml:
2631               schema:
2632                 $ref: '#/components/schemas/Response'
2633         406:
2634           description: The system is an administrative state that prevents this request
2635             to be fulfilled
2636           content: {}
2637   /topics/sources/{comm}/{topic}/switches:
2638     get:
2639       tags:
2640         - pdp-d-telemetry
2641       summary: Topic Control Switches
2642       description: List of the Topic Control Switches
2643       operationId: commSourceTopicSwitches
2644       parameters:
2645       - name: comm
2646         in: path
2647         description: Communication Mechanism
2648         required: true
2649         schema:
2650           pattern: ueb|dmaap|noop
2651           type: string
2652       - name: topic
2653         in: path
2654         description: Topic Name
2655         required: true
2656         schema:
2657           type: string
2658       responses:
2659         200:
2660           description: successful operation
2661           content:
2662             application/json:
2663               schema:
2664                 $ref: '#/components/schemas/Response'
2665             application/yaml:
2666               schema:
2667                 $ref: '#/components/schemas/Response'
2668   /topics/sinks/{comm}/{topic}/switches:
2669     get:
2670       tags:
2671         - pdp-d-telemetry
2672       summary: Topic Control Switches
2673       description: List of the Topic Control Switches
2674       operationId: commSinkTopicSwitches
2675       parameters:
2676       - name: comm
2677         in: path
2678         description: Communication Mechanism
2679         required: true
2680         schema:
2681           pattern: ueb|dmaap|noop
2682           type: string
2683       - name: topic
2684         in: path
2685         description: Topic Name
2686         required: true
2687         schema:
2688           type: string
2689       responses:
2690         200:
2691           description: successful operation
2692           content:
2693             application/json:
2694               schema:
2695                 $ref: '#/components/schemas/Response'
2696             application/yaml:
2697               schema:
2698                 $ref: '#/components/schemas/Response'
2699   /topics/sources/{comm}/{topic}/switches/lock:
2700     put:
2701       tags:
2702         - pdp-d-telemetry
2703       summary: Locks a topic
2704       operationId: commSourceTopicLock
2705       parameters:
2706       - name: comm
2707         in: path
2708         description: Communication Mechanism
2709         required: true
2710         schema:
2711           pattern: ueb|dmaap|noop
2712           type: string
2713       - name: topic
2714         in: path
2715         description: Topic Name
2716         required: true
2717         schema:
2718           type: string
2719       responses:
2720         200:
2721           description: successful operation
2722           content:
2723             application/json:
2724               schema:
2725                 $ref: '#/components/schemas/Response'
2726             application/yaml:
2727               schema:
2728                 $ref: '#/components/schemas/Response'
2729         406:
2730           description: The system is an administrative state that prevents this request
2731             to be fulfilled
2732           content: {}
2733     delete:
2734       tags:
2735         - pdp-d-telemetry
2736       summary: Unlocks topic
2737       operationId: commSourceTopicUnlock
2738       parameters:
2739       - name: comm
2740         in: path
2741         description: Communication Mechanism
2742         required: true
2743         schema:
2744           pattern: ueb|dmaap|noop
2745           type: string
2746       - name: topic
2747         in: path
2748         description: Topic Name
2749         required: true
2750         schema:
2751           type: string
2752       responses:
2753         200:
2754           description: successful operation
2755           content:
2756             application/json:
2757               schema:
2758                 $ref: '#/components/schemas/Response'
2759             application/yaml:
2760               schema:
2761                 $ref: '#/components/schemas/Response'
2762         406:
2763           description: The system is an administrative state that prevents this request
2764             to be fulfilled
2765           content: {}
2766   /topics/sources/{comm}/{topic}/switches/activation:
2767     put:
2768       tags:
2769         - pdp-d-telemetry
2770       summary: Starts a topic
2771       operationId: commSourceTopicActivation
2772       parameters:
2773       - name: comm
2774         in: path
2775         description: Communication Mechanism
2776         required: true
2777         schema:
2778           pattern: ueb|dmaap|noop
2779           type: string
2780       - name: topic
2781         in: path
2782         description: Topic Name
2783         required: true
2784         schema:
2785           type: string
2786       responses:
2787         200:
2788           description: successful operation
2789           content:
2790             application/json:
2791               schema:
2792                 $ref: '#/components/schemas/Response'
2793             application/yaml:
2794               schema:
2795                 $ref: '#/components/schemas/Response'
2796         406:
2797           description: The system is an administrative state that prevents this request
2798             to be fulfilled
2799           content: {}
2800     delete:
2801       tags:
2802         - pdp-d-telemetry
2803       summary: Stops a topic
2804       operationId: commSourceTopicDeactivation
2805       parameters:
2806       - name: comm
2807         in: path
2808         description: Communication Mechanism
2809         required: true
2810         schema:
2811           pattern: ueb|dmaap|noop
2812           type: string
2813       - name: topic
2814         in: path
2815         description: Topic Name
2816         required: true
2817         schema:
2818           type: string
2819       responses:
2820         200:
2821           description: successful operation
2822           content:
2823             application/json:
2824               schema:
2825                 $ref: '#/components/schemas/Response'
2826             application/yaml:
2827               schema:
2828                 $ref: '#/components/schemas/Response'
2829         406:
2830           description: The system is an administrative state that prevents this request
2831             to be fulfilled
2832           content: {}
2833   /topics/sinks/{comm}/{topic}/switches/activation:
2834     put:
2835       tags:
2836         - pdp-d-telemetry
2837       summary: Starts a topic sink
2838       operationId: commSinkTopicActivation
2839       parameters:
2840       - name: comm
2841         in: path
2842         description: Communication Mechanism
2843         required: true
2844         schema:
2845           pattern: ueb|dmaap|noop
2846           type: string
2847       - name: topic
2848         in: path
2849         description: Topic Name
2850         required: true
2851         schema:
2852           type: string
2853       responses:
2854         200:
2855           description: successful operation
2856           content:
2857             application/json:
2858               schema:
2859                 $ref: '#/components/schemas/Response'
2860             application/yaml:
2861               schema:
2862                 $ref: '#/components/schemas/Response'
2863         406:
2864           description: The system is an administrative state that prevents this request
2865             to be fulfilled
2866           content: {}
2867     delete:
2868       tags:
2869         - pdp-d-telemetry
2870       summary: Stops a topic
2871       operationId: commSinkTopicDeactivation
2872       parameters:
2873       - name: comm
2874         in: path
2875         description: Communication Mechanism
2876         required: true
2877         schema:
2878           pattern: ueb|dmaap|noop
2879           type: string
2880       - name: topic
2881         in: path
2882         description: Topic Name
2883         required: true
2884         schema:
2885           type: string
2886       responses:
2887         200:
2888           description: successful operation
2889           content:
2890             application/json:
2891               schema:
2892                 $ref: '#/components/schemas/Response'
2893             application/yaml:
2894               schema:
2895                 $ref: '#/components/schemas/Response'
2896         406:
2897           description: The system is an administrative state that prevents this request
2898             to be fulfilled
2899           content: {}
2900   /legacy/config/properties:
2901     get:
2902       tags:
2903         - pdp-d-legacy
2904       summary: Legacy Engine Configuration Properties
2905       description: Used for booststrapping the engine
2906       operationId: properties
2907       responses:
2908         200:
2909           description: successful operation
2910           content:
2911             application/json:
2912               schema:
2913                 $ref: '#/components/schemas/Response'
2914             application/yaml:
2915               schema:
2916                 $ref: '#/components/schemas/Response'
2917   /legacy/config/topic/source:
2918     get:
2919       tags:
2920         - pdp-d-legacy
2921       summary: Retrieves the legacy configuration topic source
2922       description: Legacy Topic Source
2923       operationId: source
2924       responses:
2925         200:
2926           description: successful operation
2927           content:
2928             application/json:
2929               schema:
2930                 $ref: '#/components/schemas/Response'
2931             application/yaml:
2932               schema:
2933                 $ref: '#/components/schemas/Response'
2934 components:
2935   schemas:
2936     TopicSink:
2937       type: object
2938       properties:
2939         effectiveTopic:
2940           type: string
2941         recentEvents:
2942           type: array
2943           items:
2944             type: string
2945         topic:
2946           type: string
2947         servers:
2948           type: array
2949           items:
2950             type: string
2951         topicCommInfrastructure:
2952           type: string
2953           enum:
2954           - UEB
2955           - DMAAP
2956           - KAFKA
2957           - NOOP
2958           - REST
2959         alive:
2960           type: boolean
2961         locked:
2962           type: boolean
2963     PolicyTypeController:
2964       type: object
2965       properties:
2966         policyType:
2967           $ref: '#/components/schemas/ToscaConceptIdentifier'
2968     ToscaConceptIdentifier:
2969       type: object
2970       properties:
2971         name:
2972           type: string
2973         version:
2974           type: string
2975     PdpEngineWorkerStatistics:
2976       type: object
2977       properties:
2978         engineId:
2979           type: string
2980         engineWorkerState:
2981           type: string
2982           enum:
2983           - UNDEFINED
2984           - STOPPED
2985           - READY
2986           - EXECUTING
2987           - STOPPING
2988         engineTimeStamp:
2989           type: integer
2990           format: int64
2991         eventCount:
2992           type: integer
2993           format: int64
2994         lastExecutionTime:
2995           type: integer
2996           format: int64
2997         averageExecutionTime:
2998           type: number
2999           format: double
3000         upTime:
3001           type: integer
3002           format: int64
3003         lastEnterTime:
3004           type: integer
3005           format: int64
3006         lastStart:
3007           type: integer
3008           format: int64
3009     PdpStatistics:
3010       type: object
3011       properties:
3012         pdpInstanceId:
3013           type: string
3014         timeStamp:
3015           type: integer
3016           format: int64
3017         generatedId:
3018           type: integer
3019           format: int64
3020         pdpGroupName:
3021           type: string
3022         pdpSubGroupName:
3023           type: string
3024         policyExecutedCount:
3025           type: integer
3026           format: int64
3027         policyExecutedSuccessCount:
3028           type: integer
3029           format: int64
3030         policyExecutedFailCount:
3031           type: integer
3032           format: int64
3033         policyDeployCount:
3034           type: integer
3035           format: int64
3036         policyDeploySuccessCount:
3037           type: integer
3038           format: int64
3039         policyDeployFailCount:
3040           type: integer
3041           format: int64
3042         policyUndeployCount:
3043           type: integer
3044           format: int64
3045         policyUndeploySuccessCount:
3046           type: integer
3047           format: int64
3048         policyUndeployFailCount:
3049           type: integer
3050           format: int64
3051         engineStats:
3052           type: array
3053           items:
3054             $ref: '#/components/schemas/PdpEngineWorkerStatistics'
3055     TopicSource:
3056       type: object
3057       properties:
3058         effectiveTopic:
3059           type: string
3060         recentEvents:
3061           type: array
3062           items:
3063             type: string
3064         topic:
3065           type: string
3066         servers:
3067           type: array
3068           items:
3069             type: string
3070         topicCommInfrastructure:
3071           type: string
3072           enum:
3073           - UEB
3074           - DMAAP
3075           - KAFKA
3076           - NOOP
3077           - REST
3078         alive:
3079           type: boolean
3080         locked:
3081           type: boolean
3082     ToscaEntityKey:
3083       type: object
3084       properties:
3085         name:
3086           type: string
3087         version:
3088           type: string
3089     ToscaPolicy:
3090       type: object
3091       properties:
3092         name:
3093           type: string
3094         version:
3095           type: string
3096         derived_from:
3097           type: string
3098         metadata:
3099           type: object
3100           additionalProperties:
3101             type: object
3102             properties: {}
3103         description:
3104           type: string
3105         type:
3106           type: string
3107         type_version:
3108           type: string
3109         properties:
3110           type: object
3111           additionalProperties:
3112             type: object
3113             properties: {}
3114         identifier:
3115           $ref: '#/components/schemas/ToscaConceptIdentifier'
3116         typeIdentifier:
3117           $ref: '#/components/schemas/ToscaConceptIdentifier'
3118         definedName:
3119           type: string
3120         definedVersion:
3121           type: string
3122         key:
3123           $ref: '#/components/schemas/ToscaEntityKey'
3124     Agenda:
3125       type: object
3126     AgendaEventListener:
3127       type: object
3128     Annotation:
3129       type: object
3130     Calendars:
3131       type: object
3132     Channel:
3133       type: object
3134     ClassLoader:
3135       type: object
3136       properties:
3137         parent:
3138           $ref: '#/components/schemas/ClassLoader'
3139         name:
3140           type: string
3141         unnamedModule:
3142           $ref: '#/components/schemas/Module'
3143         registeredAsParallelCapable:
3144           type: boolean
3145         definedPackages:
3146           type: array
3147           items:
3148             $ref: '#/components/schemas/Package'
3149     DomainMaker:
3150       type: object
3151     DroolsController:
3152       type: object
3153       properties:
3154         baseDomainNames:
3155           type: array
3156           items:
3157             type: string
3158         recentSourceEvents:
3159           type: array
3160           items:
3161             type: object
3162             properties: {}
3163         recentSinkEvents:
3164           type: array
3165           items:
3166             type: string
3167         sessionNames:
3168           type: array
3169           items:
3170             type: string
3171         container:
3172           $ref: '#/components/schemas/PolicyContainer'
3173         artifactId:
3174           type: string
3175         groupId:
3176           type: string
3177         brained:
3178           type: boolean
3179         canonicalSessionNames:
3180           type: array
3181           items:
3182             type: string
3183         version:
3184           type: string
3185         alive:
3186           type: boolean
3187         locked:
3188           type: boolean
3189     EntryPoint:
3190       type: object
3191       properties:
3192         entryPointId:
3193           type: string
3194         objects:
3195           type: array
3196           items:
3197             type: object
3198             properties: {}
3199         factHandles:
3200           type: array
3201           items:
3202             $ref: '#/components/schemas/FactHandle'
3203         factCount:
3204           type: integer
3205           format: int64
3206     Environment:
3207       type: object
3208     FactField:
3209       type: object
3210       properties:
3211         fieldAnnotations:
3212           type: array
3213           items:
3214             $ref: '#/components/schemas/Annotation'
3215         metaData:
3216           type: object
3217           additionalProperties:
3218             type: object
3219             properties: {}
3220         key:
3221           type: boolean
3222         name:
3223           type: string
3224         index:
3225           type: integer
3226           format: int32
3227     FactHandle:
3228       type: object
3229     FactType:
3230       type: object
3231       properties:
3232         metaData:
3233           type: object
3234           additionalProperties:
3235             type: object
3236             properties: {}
3237         superClass:
3238           type: string
3239         classAnnotations:
3240           type: array
3241           items:
3242             $ref: '#/components/schemas/Annotation'
3243         name:
3244           type: string
3245         packageName:
3246           type: string
3247         simpleName:
3248           type: string
3249         fields:
3250           type: array
3251           items:
3252             $ref: '#/components/schemas/FactField'
3253     Global:
3254       type: object
3255       properties:
3256         name:
3257           type: string
3258         type:
3259           type: string
3260     Globals:
3261       type: object
3262       properties:
3263         globalKeys:
3264           type: array
3265           items:
3266             type: string
3267     HttpServletServer:
3268       type: object
3269       properties:
3270         prometheus:
3271           type: boolean
3272         aaf:
3273           type: boolean
3274         name:
3275           type: string
3276         port:
3277           type: integer
3278           format: int32
3279         alive:
3280           type: boolean
3281     InputStream:
3282       type: object
3283     KieBase:
3284       type: object
3285       properties:
3286         processes:
3287           type: array
3288           items:
3289             $ref: '#/components/schemas/Process'
3290         kieSessions:
3291           type: array
3292           items:
3293             $ref: '#/components/schemas/KieSession'
3294         entryPointIds:
3295           uniqueItems: true
3296           type: array
3297           items:
3298             type: string
3299         kiePackages:
3300           type: array
3301           items:
3302             $ref: '#/components/schemas/KiePackage'
3303         kieBaseEventListeners:
3304           type: array
3305           items:
3306             $ref: '#/components/schemas/KieBaseEventListener'
3307     KieBaseEventListener:
3308       type: object
3309     KieContainer:
3310       type: object
3311       properties:
3312         kieSessionConfiguration:
3313           $ref: '#/components/schemas/KieSessionConfiguration'
3314         releaseId:
3315           $ref: '#/components/schemas/ReleaseId'
3316         kieBase:
3317           $ref: '#/components/schemas/KieBase'
3318         kieBaseNames:
3319           type: array
3320           items:
3321             type: string
3322         classLoader:
3323           $ref: '#/components/schemas/ClassLoader'
3324     KiePackage:
3325       type: object
3326       properties:
3327         processes:
3328           type: array
3329           items:
3330             $ref: '#/components/schemas/Process'
3331         factTypes:
3332           type: array
3333           items:
3334             $ref: '#/components/schemas/FactType'
3335         queries:
3336           type: array
3337           items:
3338             $ref: '#/components/schemas/Query'
3339         functionNames:
3340           type: array
3341           items:
3342             type: string
3343         globalVariables:
3344           type: array
3345           items:
3346             $ref: '#/components/schemas/Global'
3347         rules:
3348           type: array
3349           items:
3350             $ref: '#/components/schemas/Rule'
3351         name:
3352           type: string
3353     KieRuntimeLogger:
3354       type: object
3355     KieSession:
3356       type: object
3357       properties:
3358         identifier:
3359           type: integer
3360           format: int64
3361         id:
3362           type: integer
3363           format: int32
3364         globals:
3365           $ref: '#/components/schemas/Globals'
3366         kieBase:
3367           $ref: '#/components/schemas/KieBase'
3368         sessionClock:
3369           $ref: '#/components/schemas/SessionClock'
3370         sessionConfiguration:
3371           $ref: '#/components/schemas/KieSessionConfiguration'
3372         calendars:
3373           $ref: '#/components/schemas/Calendars'
3374         channels:
3375           type: object
3376           additionalProperties:
3377             $ref: '#/components/schemas/Channel'
3378         environment:
3379           $ref: '#/components/schemas/Environment'
3380         agenda:
3381           $ref: '#/components/schemas/Agenda'
3382         entryPoints:
3383           type: array
3384           items:
3385             $ref: '#/components/schemas/EntryPoint'
3386         entryPointId:
3387           type: string
3388         objects:
3389           type: array
3390           items:
3391             type: object
3392             properties: {}
3393         factHandles:
3394           type: array
3395           items:
3396             $ref: '#/components/schemas/FactHandle'
3397         factCount:
3398           type: integer
3399           format: int64
3400         processInstances:
3401           type: array
3402           items:
3403             $ref: '#/components/schemas/ProcessInstance'
3404         workItemManager:
3405           $ref: '#/components/schemas/WorkItemManager'
3406         logger:
3407           $ref: '#/components/schemas/KieRuntimeLogger'
3408         ruleRuntimeEventListeners:
3409           type: array
3410           items:
3411             $ref: '#/components/schemas/RuleRuntimeEventListener'
3412         agendaEventListeners:
3413           type: array
3414           items:
3415             $ref: '#/components/schemas/AgendaEventListener'
3416         processEventListeners:
3417           type: array
3418           items:
3419             $ref: '#/components/schemas/ProcessEventListener'
3420     KieSessionConfiguration:
3421       type: object
3422     Module:
3423       type: object
3424       properties:
3425         layer:
3426           $ref: '#/components/schemas/ModuleLayer'
3427         name:
3428           type: string
3429         descriptor:
3430           $ref: '#/components/schemas/ModuleDescriptor'
3431         classLoader:
3432           $ref: '#/components/schemas/ClassLoader'
3433         annotations:
3434           type: array
3435           items:
3436             $ref: '#/components/schemas/Annotation'
3437         declaredAnnotations:
3438           type: array
3439           items:
3440             $ref: '#/components/schemas/Annotation'
3441         named:
3442           type: boolean
3443         packages:
3444           uniqueItems: true
3445           type: array
3446           items:
3447             type: string
3448     ModuleDescriptor:
3449       type: object
3450       properties:
3451         open:
3452           type: boolean
3453         automatic:
3454           type: boolean
3455     ModuleLayer:
3456       type: object
3457     Package:
3458       type: object
3459       properties:
3460         name:
3461           type: string
3462         specificationTitle:
3463           type: string
3464         specificationVersion:
3465           type: string
3466         specificationVendor:
3467           type: string
3468         implementationTitle:
3469           type: string
3470         implementationVersion:
3471           type: string
3472         implementationVendor:
3473           type: string
3474         annotations:
3475           type: array
3476           items:
3477             $ref: '#/components/schemas/Annotation'
3478         declaredAnnotations:
3479           type: array
3480           items:
3481             $ref: '#/components/schemas/Annotation'
3482         sealed:
3483           type: boolean
3484     PolicyContainer:
3485       type: object
3486       properties:
3487         kieContainer:
3488           $ref: '#/components/schemas/KieContainer'
3489         policySessions:
3490           type: array
3491           items:
3492             $ref: '#/components/schemas/PolicySession'
3493         artifactId:
3494           type: string
3495         groupId:
3496           type: string
3497         version:
3498           type: string
3499         name:
3500           type: string
3501         classLoader:
3502           $ref: '#/components/schemas/ClassLoader'
3503         alive:
3504           type: boolean
3505     PolicyController:
3506       type: object
3507       properties:
3508         topicSources:
3509           type: array
3510           items:
3511             $ref: '#/components/schemas/TopicSource'
3512         policyTypes:
3513           type: array
3514           items:
3515             $ref: '#/components/schemas/ToscaConceptIdentifier'
3516         topicSinks:
3517           type: array
3518           items:
3519             $ref: '#/components/schemas/TopicSink'
3520         drools:
3521           $ref: '#/components/schemas/DroolsController'
3522         name:
3523           type: string
3524         properties:
3525           type: object
3526           additionalProperties:
3527             type: string
3528         alive:
3529           type: boolean
3530         locked:
3531           type: boolean
3532     PolicyEngine:
3533       type: object
3534       properties:
3535         httpServers:
3536           type: array
3537           items:
3538             $ref: '#/components/schemas/HttpServletServer'
3539         policyControllers:
3540           type: array
3541           items:
3542             $ref: '#/components/schemas/PolicyController'
3543         policyControllerIds:
3544           type: array
3545           items:
3546             type: string
3547         featureProviders:
3548           type: array
3549           items:
3550             $ref: '#/components/schemas/PolicyEngineFeatureApi'
3551         features:
3552           type: array
3553           items:
3554             type: string
3555         domainMaker:
3556           $ref: '#/components/schemas/DomainMaker'
3557         stats:
3558           $ref: '#/components/schemas/PolicyStatsManager'
3559         environment:
3560           type: object
3561           additionalProperties:
3562             type: string
3563         clusterName:
3564           type: string
3565         pdpName:
3566           type: string
3567         sources:
3568           type: array
3569           items:
3570             $ref: '#/components/schemas/TopicSource'
3571         sinks:
3572           type: array
3573           items:
3574             $ref: '#/components/schemas/TopicSink'
3575         executorService:
3576           $ref: '#/components/schemas/ScheduledExecutorService'
3577         properties:
3578           type: object
3579           additionalProperties:
3580             type: string
3581         hostName:
3582           type: string
3583         alive:
3584           type: boolean
3585         locked:
3586           type: boolean
3587     PolicyEngineFeatureApi:
3588       type: object
3589       properties:
3590         sequenceNumber:
3591           type: integer
3592           format: int32
3593         name:
3594           type: string
3595     PolicySession:
3596       type: object
3597       properties:
3598         name:
3599           type: string
3600         container:
3601           $ref: '#/components/schemas/PolicyContainer'
3602         kieSession:
3603           $ref: '#/components/schemas/KieSession'
3604         fullName:
3605           type: string
3606     PolicyStats:
3607       type: object
3608       properties:
3609         policyExecutedCount:
3610           type: integer
3611           format: int64
3612         policyExecutedSuccessCount:
3613           type: integer
3614           format: int64
3615         policyExecutedFailCount:
3616           type: integer
3617           format: int64
3618         lastExecutionTime:
3619           type: integer
3620           format: int64
3621         averageExecutionTime:
3622           type: number
3623           format: double
3624         totalElapsedTime:
3625           type: number
3626           format: double
3627         birthTime:
3628           type: integer
3629           format: int64
3630         lastStart:
3631           type: integer
3632           format: int64
3633     PolicyStatsManager:
3634       type: object
3635       properties:
3636         groupStat:
3637           $ref: '#/components/schemas/PolicyStats'
3638         subgroupStats:
3639           type: object
3640           additionalProperties:
3641             $ref: '#/components/schemas/PolicyStats'
3642     Process:
3643       type: object
3644       properties:
3645         resource:
3646           $ref: '#/components/schemas/Resource'
3647         metaData:
3648           type: object
3649           additionalProperties:
3650             type: object
3651             properties: {}
3652         version:
3653           type: string
3654         name:
3655           type: string
3656         packageName:
3657           type: string
3658         id:
3659           type: string
3660         type:
3661           type: string
3662         knowledgeType:
3663           type: string
3664           enum:
3665           - RULE
3666           - TYPE
3667           - WINDOW
3668           - ENUM
3669           - PROCESS
3670           - FUNCTION
3671           - QUERY
3672         namespace:
3673           type: string
3674     ProcessEventListener:
3675       type: object
3676     ProcessInstance:
3677       type: object
3678       properties:
3679         parentProcessInstanceId:
3680           type: integer
3681           format: int64
3682         processName:
3683           type: string
3684         process:
3685           $ref: '#/components/schemas/Process'
3686         processId:
3687           type: string
3688         id:
3689           type: integer
3690           format: int64
3691         state:
3692           type: integer
3693           format: int32
3694         eventTypes:
3695           type: array
3696           items:
3697             type: string
3698     Query:
3699       type: object
3700       properties:
3701         metaData:
3702           type: object
3703           additionalProperties:
3704             type: object
3705             properties: {}
3706         name:
3707           type: string
3708         packageName:
3709           type: string
3710         knowledgeType:
3711           type: string
3712           enum:
3713           - RULE
3714           - TYPE
3715           - WINDOW
3716           - ENUM
3717           - PROCESS
3718           - FUNCTION
3719           - QUERY
3720         namespace:
3721           type: string
3722         id:
3723           type: string
3724     Reader:
3725       type: object
3726     ReleaseId:
3727       type: object
3728       properties:
3729         artifactId:
3730           type: string
3731         groupId:
3732           type: string
3733         snapshot:
3734           type: boolean
3735         version:
3736           type: string
3737     Resource:
3738       type: object
3739       properties:
3740         configuration:
3741           $ref: '#/components/schemas/ResourceConfiguration'
3742         targetPath:
3743           type: string
3744         resourceType:
3745           $ref: '#/components/schemas/ResourceType'
3746         sourcePath:
3747           type: string
3748         reader:
3749           $ref: '#/components/schemas/Reader'
3750         inputStream:
3751           $ref: '#/components/schemas/InputStream'
3752     ResourceConfiguration:
3753       type: object
3754     ResourceType:
3755       type: object
3756       properties:
3757         name:
3758           type: string
3759         description:
3760           type: string
3761         defaultExtension:
3762           type: string
3763         defaultPath:
3764           type: string
3765         fullyCoveredByExecModel:
3766           type: boolean
3767         allExtensions:
3768           type: array
3769           items:
3770             type: string
3771     Rule:
3772       type: object
3773       properties:
3774         metaData:
3775           type: object
3776           additionalProperties:
3777             type: object
3778             properties: {}
3779         name:
3780           type: string
3781         packageName:
3782           type: string
3783         knowledgeType:
3784           type: string
3785           enum:
3786           - RULE
3787           - TYPE
3788           - WINDOW
3789           - ENUM
3790           - PROCESS
3791           - FUNCTION
3792           - QUERY
3793         namespace:
3794           type: string
3795         id:
3796           type: string
3797     RuleRuntimeEventListener:
3798       type: object
3799     ScheduledExecutorService:
3800       type: object
3801       properties:
3802         terminated:
3803           type: boolean
3804         shutdown:
3805           type: boolean
3806     SessionClock:
3807       type: object
3808       properties:
3809         currentTime:
3810           type: integer
3811           format: int64
3812     WorkItemManager:
3813       type: object
3814     PolicyControllerFeatureApi:
3815       type: object
3816       properties:
3817         sequenceNumber:
3818           type: integer
3819           format: int32
3820         name:
3821           type: string
3822     ControllerConfiguration:
3823       type: object
3824       properties:
3825         name:
3826           type: string
3827         operation:
3828           type: string
3829         drools:
3830           $ref: '#/components/schemas/DroolsConfiguration'
3831         additionalProperties:
3832           type: object
3833           additionalProperties:
3834             type: object
3835             properties: {}
3836     DroolsConfiguration:
3837       type: object
3838       properties:
3839         artifactId:
3840           type: string
3841         groupId:
3842           type: string
3843         version:
3844           type: string
3845         additionalProperties:
3846           type: object
3847           additionalProperties:
3848             type: object
3849             properties: {}
3850     CoderFilters:
3851       type: object
3852       properties:
3853         factClass:
3854           type: string
3855         filter:
3856           $ref: '#/components/schemas/JsonProtocolFilter'
3857         modelClassLoaderHash:
3858           type: integer
3859           format: int32
3860     CustomCoder:
3861       type: object
3862       properties:
3863         classContainer:
3864           type: string
3865         staticCoderField:
3866           type: string
3867     JsonProtocolFilter:
3868       type: object
3869       properties:
3870         rule:
3871           type: string
3872     ProtocolCoderToolset:
3873       type: object
3874       properties:
3875         topic:
3876           type: string
3877         controllerId:
3878           type: string
3879         groupId:
3880           type: string
3881         artifactId:
3882           type: string
3883         coders:
3884           type: array
3885           items:
3886             $ref: '#/components/schemas/CoderFilters'
3887         customCoder:
3888           $ref: '#/components/schemas/CustomCoder'
3889     DmaapTopicSink:
3890       type: object
3891       properties:
3892         partitionKey:
3893           type: string
3894         apiKey:
3895           type: string
3896         apiSecret:
3897           type: string
3898         effectiveTopic:
3899           type: string
3900         recentEvents:
3901           type: array
3902           items:
3903             type: string
3904         topic:
3905           type: string
3906         servers:
3907           type: array
3908           items:
3909             type: string
3910         topicCommInfrastructure:
3911           type: string
3912           enum:
3913           - UEB
3914           - DMAAP
3915           - KAFKA
3916           - NOOP
3917           - REST
3918         alive:
3919           type: boolean
3920         locked:
3921           type: boolean
3922     DmaapTopicSource:
3923       type: object
3924       properties:
3925         consumerInstance:
3926           type: string
3927         consumerGroup:
3928           type: string
3929         fetchTimeout:
3930           type: integer
3931           format: int32
3932         fetchLimit:
3933           type: integer
3934           format: int32
3935         apiKey:
3936           type: string
3937         apiSecret:
3938           type: string
3939         effectiveTopic:
3940           type: string
3941         recentEvents:
3942           type: array
3943           items:
3944             type: string
3945         topic:
3946           type: string
3947         servers:
3948           type: array
3949           items:
3950             type: string
3951         topicCommInfrastructure:
3952           type: string
3953           enum:
3954           - UEB
3955           - DMAAP
3956           - KAFKA
3957           - NOOP
3958           - REST
3959         alive:
3960           type: boolean
3961         locked:
3962           type: boolean
3963     KafkaTopicSink:
3964       type: object
3965       properties:
3966         partitionKey:
3967           type: string
3968         apiKey:
3969           type: string
3970         apiSecret:
3971           type: string
3972         effectiveTopic:
3973           type: string
3974         recentEvents:
3975           type: array
3976           items:
3977             type: string
3978         topic:
3979           type: string
3980         servers:
3981           type: array
3982           items:
3983             type: string
3984         topicCommInfrastructure:
3985           type: string
3986           enum:
3987           - UEB
3988           - DMAAP
3989           - KAFKA
3990           - NOOP
3991           - REST
3992         alive:
3993           type: boolean
3994         locked:
3995           type: boolean
3996     KafkaTopicSource:
3997       type: object
3998       properties:
3999         consumerInstance:
4000           type: string
4001         consumerGroup:
4002           type: string
4003         fetchTimeout:
4004           type: integer
4005           format: int32
4006         fetchLimit:
4007           type: integer
4008           format: int32
4009         apiKey:
4010           type: string
4011         apiSecret:
4012           type: string
4013         effectiveTopic:
4014           type: string
4015         recentEvents:
4016           type: array
4017           items:
4018             type: string
4019         topic:
4020           type: string
4021         servers:
4022           type: array
4023           items:
4024             type: string
4025         topicCommInfrastructure:
4026           type: string
4027           enum:
4028           - UEB
4029           - DMAAP
4030           - KAFKA
4031           - NOOP
4032           - REST
4033         alive:
4034           type: boolean
4035         locked:
4036           type: boolean
4037     NoopTopicSink:
4038       type: object
4039       properties:
4040         servers:
4041           type: array
4042           items:
4043             type: string
4044         topic:
4045           type: string
4046         effectiveTopic:
4047           type: string
4048         recentEvents:
4049           type: array
4050           items:
4051             type: string
4052         alive:
4053           type: boolean
4054         locked:
4055           type: boolean
4056         topicCommInfrastructure:
4057           type: string
4058           enum:
4059           - UEB
4060           - DMAAP
4061           - KAFKA
4062           - NOOP
4063           - REST
4064     NoopTopicSource:
4065       type: object
4066       properties:
4067         servers:
4068           type: array
4069           items:
4070             type: string
4071         topic:
4072           type: string
4073         effectiveTopic:
4074           type: string
4075         recentEvents:
4076           type: array
4077           items:
4078             type: string
4079         alive:
4080           type: boolean
4081         locked:
4082           type: boolean
4083         topicCommInfrastructure:
4084           type: string
4085           enum:
4086           - UEB
4087           - DMAAP
4088           - KAFKA
4089           - NOOP
4090           - REST
4091     TopicEndpoint:
4092       type: object
4093       properties:
4094         uebTopicSources:
4095           type: array
4096           items:
4097             $ref: '#/components/schemas/UebTopicSource'
4098         uebTopicSinks:
4099           type: array
4100           items:
4101             $ref: '#/components/schemas/UebTopicSink'
4102         dmaapTopicSinks:
4103           type: array
4104           items:
4105             $ref: '#/components/schemas/DmaapTopicSink'
4106         kafkaTopicSinks:
4107           type: array
4108           items:
4109             $ref: '#/components/schemas/KafkaTopicSink'
4110         noopTopicSinks:
4111           type: array
4112           items:
4113             $ref: '#/components/schemas/NoopTopicSink'
4114         dmaapTopicSources:
4115           type: array
4116           items:
4117             $ref: '#/components/schemas/DmaapTopicSource'
4118         kafkaTopicSources:
4119           type: array
4120           items:
4121             $ref: '#/components/schemas/KafkaTopicSource'
4122         noopTopicSources:
4123           type: array
4124           items:
4125             $ref: '#/components/schemas/NoopTopicSource'
4126         topicSources:
4127           type: array
4128           items:
4129             $ref: '#/components/schemas/TopicSource'
4130         topicSinks:
4131           type: array
4132           items:
4133             $ref: '#/components/schemas/TopicSink'
4134         alive:
4135           type: boolean
4136         locked:
4137           type: boolean
4138     UebTopicSink:
4139       type: object
4140       properties:
4141         partitionKey:
4142           type: string
4143         apiKey:
4144           type: string
4145         apiSecret:
4146           type: string
4147         effectiveTopic:
4148           type: string
4149         recentEvents:
4150           type: array
4151           items:
4152             type: string
4153         topic:
4154           type: string
4155         servers:
4156           type: array
4157           items:
4158             type: string
4159         topicCommInfrastructure:
4160           type: string
4161           enum:
4162           - UEB
4163           - DMAAP
4164           - KAFKA
4165           - NOOP
4166           - REST
4167         alive:
4168           type: boolean
4169         locked:
4170           type: boolean
4171     UebTopicSource:
4172       type: object
4173       properties:
4174         consumerInstance:
4175           type: string
4176         consumerGroup:
4177           type: string
4178         fetchTimeout:
4179           type: integer
4180           format: int32
4181         fetchLimit:
4182           type: integer
4183           format: int32
4184         apiKey:
4185           type: string
4186         apiSecret:
4187           type: string
4188         effectiveTopic:
4189           type: string
4190         recentEvents:
4191           type: array
4192           items:
4193             type: string
4194         topic:
4195           type: string
4196         servers:
4197           type: array
4198           items:
4199             type: string
4200         topicCommInfrastructure:
4201           type: string
4202           enum:
4203           - UEB
4204           - DMAAP
4205           - KAFKA
4206           - NOOP
4207           - REST
4208         alive:
4209           type: boolean
4210         locked:
4211           type: boolean
4212     PdpdConfiguration:
4213       type: object
4214       properties:
4215         requestId:
4216           type: string
4217         entity:
4218           type: string
4219         controllers:
4220           type: array
4221           items:
4222             $ref: '#/components/schemas/ControllerConfiguration'
4223         additionalProperties:
4224           type: object
4225           additionalProperties:
4226             type: object
4227             properties: {}
4228     CodingResult:
4229       type: object
4230       properties:
4231         jsonEncoding:
4232           type: string
4233         encoding:
4234           type: boolean
4235         decoding:
4236           type: boolean
4237     Response:
4238       type: object
4239     Properties:
4240       type: object