openapi.yml

openapi: 3.0.3
info:
  title: |
    The Jolokia Api Server
    (Generated by `yarn build-api-doc`.)
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 0.1.2
  description: |
    This document contains a list of currently available apis that
    can be used by the **activemq-artemis-self-provisioning plugin**
    to get access to the [management api](https://github.com/apache/activemq-artemis/blob/main/docs/user-manual/management.adoc#the-management-api) of a broker instance via 
    its [jolokia](https://jolokia.org/) endpoint.

    ### How to add new apis to the src

    The api server uses [openapi](https://www.openapis.org/) to define
    its apis. All the apis are defined in the file [openapi.yml](src/config/openapi.yml).

    To add a new api first open the [openapi.yml](src/config/openapi.yml)
    and add a new api definition, for example:

    ```yaml
    /hello:
      get:
        description: hello api
        tags:
          - greeting
        operationId: hello
        parameters:
        - name: name
          required: false
          in: query
          description: The name of a caller
          schema:
            type: string
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DummyResponse'
      ```

    With the above section added, you defined the new api under the path `/hello`
    and uses http `GET` method. It takes one optional parameter `name` of string
    type. The response contains json value and the structure is defined in
    `/components/schemas/DummyResponse` schema defined in the
    same file. The `operationId` represents the method name that implements the api.

    Next step is add the implmentation.

    Find a place to write your implementation. Your code should be 
    placed in the `src/api/controllers` directory. Either create
    a new `.ts` file or use an existing one.

    The following code shows a sample implementation:

    ```typescript
      export function hello(req: express.Request, res: express.Response): void {
      const name = req.query.name || 'stranger';
      const message = `Hello, ${name}!`;
      res.json({
        message: message,
        status: 'successful',
      });
    }
    ```

    That's it. A new api now is available under path `/api/v1/hello`.

    **Tip**: You can consider using the [swagger editor](https://github.com/swagger-api/swagger-editor) to edit the openapi.yml file.

    For more information on how to write the api definition, please
    see [openapi spec](https://spec.openapis.org/oas/latest.html)

    **Note**: If you make changes to the openapi.yml, please run `yarn build-api-doc` to update the doc.

    ### Update the generated endpoints for the frontend

    After any change to the api, run `yarn codegen` to regenerate the endpoints for the frontend.
    If necessary update the code that is using the hooks to comply with your changes.

servers:
  - url: /api/v1

tags:
  - name: security
    description: resurity related
  - name: jolokia
    description: jolokia API
  - name: development
    description: for development purposes

paths:
  /jolokia/login:
    post:
      summary: The login api
      description: >
        This api is used to login to a jolokia endpoint.
        It tries to get the broker mbean via the joloia url
        using the parameters passed in.

          If it succeeds, it generates a [jwt token](https://jwt.io/introduction) and returns
        it back to the client. If it fails it returns a error.

          Once authenticated, the client can access the
        apis defined in this file. With each request the client
        must include a valid jwt token in a http header
        named `jolokia-session-id`.
        The src will validate the token before processing a request is
        and rejects the request if the token is not valid.
      tags:
        - security
      operationId: login
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                brokerName:
                  type: string
                  description: 'identity of the broker instance, must in form of {cr-name}-{pod-ordinal}:{namespace}. For example ex-aao-0:test1'
                userName:
                  type: string
                  description: 'The user name'
                password:
                  type: string
                  description: 'The password'
                jolokiaHost:
                  type: string
                  description: 'The host name of the broker'
                scheme:
                  type: string
                  description: 'either *http* or *https*'
                port:
                  type: string
                  description: 'port number of jolokia endpoint'
              required:
                - brokerName
                - userName
                - password
                - jolokiaHost
                - scheme
                - port
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginResponse'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /brokers:
    get:
      summary: retrieve the broker mbean
      description: >
        **Get the broker mbean**
          The return value is a one-element array that contains
          the broker's mbean object name.
      tags:
        - jolokia
      operationId: getBrokers
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Broker'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /brokerDetails:
    get:
      summary: broker details
      description: >
        **Get the broker details**
          The return value is a json object that contains
          description of all the operations and attributes of the broker's mbean.
          It is defined in [ActiveMQServerControl.java](https://github.com/apache/activemq-artemis/blob/2.33.0/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/ActiveMQServerControl.java)
      tags:
        - jolokia
      operationId: getBrokerDetails
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentDetails'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /readBrokerAttributes:
    get:
      summary: read broker attributes
      description: >
        **Read values of broker attributes**
          The return value is a json array that contains
          values of requested attributes of the broker's mbean.

          **Note**: to read multiple attributes, set it to **names** parameter
          separated by commas, e.g. `Version,Status`.
      tags:
        - jolokia
      operationId: readBrokerAttributes
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
        - name: names
          description: attribute names separated by commas. If not speified read all attributes.
          required: false
          in: query
          schema:
            type: array
            items:
              type: string
          style: form
          explode: false
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComponentAttribute'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /readAddressAttributes:
    get:
      summary: read address attributes
      description: >
        **Read values of address attributes**
          The return value is a json array that contains
          values of requested attributes of the addresses's mbean.

          **Note**: to read multiple attributes, set it to **attrs** parameter
          separated by commas, e.g. `RoutingTypes,Address`.
      tags:
        - jolokia
      operationId: readAddressAttributes
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
        - name: name
          description: the address name
          schema:
            type: string
          required: true
          in: query
        - name: attrs
          description: attribute names separated by commas. If not speified read all attributes.
          required: false
          in: query
          schema:
            type: array
            items:
              type: string
          style: form
          explode: false
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComponentAttribute'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /readQueueAttributes:
    get:
      summary: read queue attributes
      description: >
        **Read values of queue attributes**
          The return value is a json array that contains
          values of requested attributes of the queue's mbean.

          **Note**: to read multiple attributes, set it to **attrs** parameter
          separated by commas, e.g. `RoutingTypes,Address`.
      tags:
        - jolokia
      operationId: readQueueAttributes
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
        - name: name
          description: the queue name
          schema:
            type: string
          required: true
          in: query
        - name: address
          description: the address name
          schema:
            type: string
          required: true
          in: query
        - name: routing-type
          description: the routing type
          schema:
            type: string
          required: true
          in: query
        - name: attrs
          description: attribute names separated by commas. If not speified read all attributes.
          required: false
          in: query
          schema:
            type: array
            items:
              type: string
          style: form
          explode: false
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComponentAttribute'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /readAcceptorAttributes:
    get:
      summary: read acceptor attributes
      description: >
        **Read values of acceptor attributes**
          The return value is a json array that contains
          values of requested attributes of the acceptor's mbean.

          **Note**: to read multiple attributes, set it to **attrs** parameter
          separated by commas, e.g. `RoutingTypes,Address`.
      tags:
        - jolokia
      operationId: readAcceptorAttributes
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
        - name: name
          description: the queue name
          schema:
            type: string
          required: true
          in: query
        - name: attrs
          description: attribute names separated by commas. If not speified read all attributes.
          required: false
          in: query
          schema:
            type: array
            items:
              type: string
          style: form
          explode: false
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComponentAttribute'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /readClusterConnectionAttributes:
    get:
      summary: read cluster connection attributes
      description: >
        **Read values of cluster connection attributes**
          The return value is a json array that contains
          values of requested attributes of the cluster connection's mbean.

          **Note**: to read multiple attributes, set it to **attrs** parameter
          separated by commas, e.g. `NodeID, Topology`.
      tags:
        - jolokia
      operationId: readClusterConnectionAttributes
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
        - name: name
          description: the cluster connection name
          schema:
            type: string
          required: true
          in: query
        - name: attrs
          description: attribute names separated by commas. If not speified read all attributes.
          required: false
          in: query
          schema:
            type: array
            items:
              type: string
          style: form
          explode: false
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComponentAttribute'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /execClusterConnectionOperation:
    post:
      summary: execute a cluster connection operation
      description: >
        **Invoke an operation of the cluster connection mbean**

          It receives a POST request where the body
          should have the operation signature and its args.
          The return value is a one element json array that contains
          return values of invoked operation along with the request info.
      tags:
        - jolokia
      operationId: execClusterConnectionOperation
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
        - in: query
          name: name
          schema:
            type: string
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperationRef'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExecResult'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'

  /checkCredentials:
    get:
      summary: Check the validity of the credentials
      tags:
        - jolokia
      operationId: checkCredentials
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/DummyResponse'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /execBrokerOperation:
    post:
      summary: execute a broker operation
      description: >
        **Invoke an operation of the broker mbean**

          It receives a POST request where the body
          should have the operation signature and its args.
          The return value is a one element json array that contains
          return values of invoked operation along with the request info.
      tags:
        - jolokia
      operationId: execBrokerOperation
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperationRef'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExecResult'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /brokerComponents:
    get:
      summary: list all mbeans
      description: >
        **List all broker components**

          It retrieves and returns a list of all mbeans
          registered directly under the broker managment domain.
      tags:
        - jolokia
      operationId: getBrokerComponents
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /addresses:
    get:
      summary: retrieve all addresses on broker
      description: >
        **Get all addresses in a broker**

          It retrieves and returns a list of all address mbeans
      tags:
        - jolokia
      operationId: getAddresses
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Address'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /queues:
    get:
      summary: list queues
      description: >
        **Get all queues in a broker**

          It retrieves and returns a list of all queue mbeans
      tags:
        - jolokia
      operationId: getQueues
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
        - name: address
          required: false
          in: query
          schema:
            type: string
            description: If given only list the queues on this address
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Queue'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /queueDetails:
    get:
      summary: retrieve queue details
      description: >
        **Get details of a queue**
          The return value is a json object that contains
          description of all the operations and attributes of the `queue` mbean.

          It is defined in [QueueControl.java](https://github.com/apache/activemq-artemis/blob/2.33.0/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/QueueControl.java)
      tags:
        - jolokia
      operationId: getQueueDetails
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
        - name: addressName
          required: false
          in: query
          schema:
            type: string
            description: the address name of the queue
        - name: name
          required: true
          in: query
          schema:
            type: string
            description: the name of the queue
        - name: routingType
          required: true
          in: query
          schema:
            type: string
            description: the routing type of the queue (anycast or multicast)
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentDetails'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /addressDetails:
    get:
      summary: retrieve address details
      description: >
        **Get details of an address**
          The return value is a json object that contains
          description of all the operations and attributes of the address mbean.

          It is defined in [AddressControl.java](https://github.com/apache/activemq-artemis/blob/2.33.0/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/AddressControl.java)
      tags:
        - jolokia
      operationId: getAddressDetails
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
        - name: name
          required: true
          in: query
          schema:
            type: string
            description: the address name
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentDetails'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /acceptors:
    get:
      summary: list acceptors
      description: >
        **Get all acceptors in a broker**

          It retrieves and returns a list of all acceptor mbeans
      tags:
        - jolokia
      operationId: getAcceptors
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Acceptor'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /acceptorDetails:
    get:
      summary: retrieve acceptor details
      description: >
        **Get details of an acceptor**
          The return value is a json object that contains
          description of all the operations and attributes of an `acceptor` mbean.

          It is defined in [AcceptorControl.java](https://github.com/apache/activemq-artemis/blob/2.33.0/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/AcceptorControl.java)
      tags:
        - jolokia
      operationId: getAcceptorDetails
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
        - name: name
          required: true
          in: query
          schema:
            type: string
            description: the acceptor name
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentDetails'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /clusterConnections:
    get:
      summary: list cluster connections
      description: >
        **Get all cluster connections in a broker**

          It retrieves and returns a list of all cluster connection mbeans
      tags:
        - jolokia
      operationId: getClusterConnections
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterConnection'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /clusterConnectionDetails:
    get:
      summary: retrieve cluster connection details
      description: >
        **Get details of a connection cluster**
          The return value is a json object that contains
          description of all the operations and attributes of a `cluster connection` mbean.

          It is defined in [ClusterConnectionControl.java](https://github.com/apache/activemq-artemis/blob/2.33.0/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/ClusterConnectionControl.java)
      tags:
        - jolokia
      operationId: getClusterConnectionDetails
      parameters:
        - in: header
          name: jolokia-session-id
          schema:
            type: string
          required: true
        - name: name
          required: true
          in: query
          schema:
            type: string
            description: the cluster connection name
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentDetails'
        401:
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
        500:
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/FailureResponse'
  /api-info:
    get:
      summary: the api info
      description: >
        **Show all exposed paths on the api server**

          The return value is a json object that contains
          description of all api paths defined in the api server.
      tags:
        - development
      operationId: apiInfo
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiResponse'

components:
  schemas:
    OperationRef:
      type: object
      properties:
        signature:
          description: The method signature
          type: object
          required:
            - name
            - args
          properties:
            name:
              type: string
            args:
              type: array
              items:
                $ref: '#/components/schemas/OperationArgument'
      required:
        - signature
    OperationArgument:
      type: object
      required:
        - type
        - value
      properties:
        type:
          $ref: '#/components/schemas/JavaTypes'
        value:
          type: string
    OperationResult:
      type: object
      required:
        - request
        - value
        - timestamp
        - status
      properties:
        request:
          type: object
          required:
            - mbean
            - arguments
            - type
            - operation
          properties:
            mbean:
              type: string
            arguments:
              type: array
              items:
                type: string
            type:
              type: string
            operation:
              type: string
        value:
          type: string
        timestamp:
          type: number
        status:
          type: number
    DummyResponse:
      type: object
      required:
        - message
        - status
      properties:
        message:
          type: string
          enum: [ok]
        status:
          type: string
          enum: [successful]
    ApiResponse:
      type: object
      properties:
        message:
          type: object
          properties:
            info:
              type: object
              properties:
                name:
                  type: string
                description:
                  type: string
                version:
                  type: string
            paths:
              type: object
              properties:
                post:
                  type: array
                  items:
                    type: string
                get:
                  type: array
                  items:
                    type: string
        status:
          type: string
          enum: [successful]
        jolokia-session-id:
          type: string
          description: The jwt token
    LoginResponse:
      type: object
      required:
        - status
        - message
        - jolokia-session-id
      properties:
        message:
          type: string
        status:
          type: string
        jolokia-session-id:
          type: string
          description: The jwt token
    Address:
      type: object
      required:
        - name
        - broker
      properties:
        name:
          type: string
        broker:
          $ref: '#/components/schemas/Broker'
    Acceptor:
      type: object
      required:
        - name
        - broker
      properties:
        name:
          type: string
        broker:
          $ref: '#/components/schemas/Broker'
    ClusterConnection:
      type: object
      required:
        - name
        - broker
      properties:
        name:
          type: string
        broker:
          $ref: '#/components/schemas/Broker'
    Queue:
      type: object
      required:
        - name
        - routing-type
        - broker
      properties:
        name:
          type: string
        routing-type:
          type: string
        address:
          $ref: '#/components/schemas/Address'
        broker:
          $ref: '#/components/schemas/Broker'
    Broker:
      type: object
      required:
        - name
      properties:
        name:
          type: string
    FailureResponse:
      type: object
      required:
        - status
        - message
      properties:
        status:
          type: string
          enum: [failed, error]
        message:
          type: string
    JavaTypes:
      type: string
      enum:
        - '[Ljava.lang.Object;'
        - '[Ljava.lang.String;'
        - '[Ljava.util.Map;'
        - '[Ljavax.management.openmbean.CompositeData;'
        - Object
        - boolean
        - double
        - int
        - java.lang.Boolean
        - java.lang.Integer
        - java.lang.Long
        - java.lang.Object
        - java.lang.String
        - java.util.Map
        - long
        - void
    ComponentDetails:
      type: object
      required:
        - op
        - attr
        - class
        - desc
      properties:
        op:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Signatures'
        attr:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Attr'
        class:
          type: string
        desc:
          type: string
    Signatures:
      type: array
      items:
        $ref: '#/components/schemas/Signature'
    Signature:
      type: object
      required:
        - desc
        - args
      properties:
        ret:
          $ref: '#/components/schemas/JavaTypes'
        desc:
          type: string
        args:
          type: array
          items:
            $ref: '#/components/schemas/Argument'
    Attr:
      type: object
      required:
        - rw
        - type
        - desc
      properties:
        desc:
          type: string
        rw:
          type: boolean
        type:
          $ref: '#/components/schemas/JavaTypes'
    Argument:
      type: object
      required:
        - name
        - type
        - desc
      properties:
        name:
          type: string
        type:
          $ref: '#/components/schemas/JavaTypes'
        desc:
          type: string
    ComponentAttribute:
      type: object
      required:
        - request
        - status
      properties:
        request:
          type: object
          required:
            - mbean
            - type
          properties:
            mbean:
              type: string
            attribute:
              type: string
            type:
              type: string
        value: {}
        error_type:
          type: string
        error:
          type: string
        timestamp:
          type: number
        status:
          type: number
    ExecResult:
      type: object
      required:
        - request
        - status
      properties:
        request:
          type: object
          required:
            - mbean
            - type
            - operation
          properties:
            mbean:
              type: string
            arguments:
              type: array
              items:
                type: string
            type:
              type: string
            operation:
              type: string
        value: {}
        error_type:
          type: string
        error:
          type: string
        timestamp:
          type: number
        status:
          type: number