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

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