Apache Knox Admin REST API — Topologies

naftiko: 1.0.0-alpha2
info:
  label: Apache Knox Admin REST API — Topologies
  description: 'Apache Knox Admin REST API — Topologies. 6 operations. Lead operation: Apache knox Apache Knox List Topologies.
    Self-contained Naftiko capability covering one Apache Knox business surface.'
  tags:
  - Apache Knox
  - Topologies
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    APACHE_KNOX_API_KEY: APACHE_KNOX_API_KEY
capability:
  consumes:
  - type: http
    namespace: admin-topologies
    baseUri: https://localhost:8443/gateway/admin
    description: Apache Knox Admin REST API — Topologies business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-topologies
      path: /api/v1/topologies
      operations:
      - name: listtopologies
        method: GET
        description: Apache knox Apache Knox List Topologies
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createtopology
        method: POST
        description: Apache knox Apache Knox Create Topology
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-v1-topologies-topologyName
      path: /api/v1/topologies/{topologyName}
      operations:
      - name: gettopology
        method: GET
        description: Apache knox Apache Knox Get Topology
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topologyName
          in: path
          type: string
          required: true
      - name: deletetopology
        method: DELETE
        description: Apache knox Apache Knox Delete Topology
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topologyName
          in: path
          type: string
          required: true
    - name: api-v1-topologies-topologyName-urls
      path: /api/v1/topologies/{topologyName}/urls
      operations:
      - name: gettopologyurls
        method: GET
        description: Apache knox Apache Knox Get Topology URLs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topologyName
          in: path
          type: string
          required: true
    - name: api-v1-version
      path: /api/v1/version
      operations:
      - name: getversion
        method: GET
        description: Apache knox Apache Knox Get Version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.APACHE_KNOX_USER}}'
      password: '{{env.APACHE_KNOX_PASS}}'
  exposes:
  - type: rest
    namespace: admin-topologies-rest
    port: 8080
    description: REST adapter for Apache Knox Admin REST API — Topologies. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v1/topologies
      name: api-v1-topologies
      description: REST surface for api-v1-topologies.
      operations:
      - method: GET
        name: listtopologies
        description: Apache knox Apache Knox List Topologies
        call: admin-topologies.listtopologies
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createtopology
        description: Apache knox Apache Knox Create Topology
        call: admin-topologies.createtopology
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/topologies/{topologyname}
      name: api-v1-topologies-topologyname
      description: REST surface for api-v1-topologies-topologyName.
      operations:
      - method: GET
        name: gettopology
        description: Apache knox Apache Knox Get Topology
        call: admin-topologies.gettopology
        with:
          topologyName: rest.topologyName
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletetopology
        description: Apache knox Apache Knox Delete Topology
        call: admin-topologies.deletetopology
        with:
          topologyName: rest.topologyName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/topologies/{topologyname}/urls
      name: api-v1-topologies-topologyname-urls
      description: REST surface for api-v1-topologies-topologyName-urls.
      operations:
      - method: GET
        name: gettopologyurls
        description: Apache knox Apache Knox Get Topology URLs
        call: admin-topologies.gettopologyurls
        with:
          topologyName: rest.topologyName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/version
      name: api-v1-version
      description: REST surface for api-v1-version.
      operations:
      - method: GET
        name: getversion
        description: Apache knox Apache Knox Get Version
        call: admin-topologies.getversion
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: admin-topologies-mcp
    port: 9090
    transport: http
    description: MCP adapter for Apache Knox Admin REST API — Topologies. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: apache-knox-apache-knox-list
      description: Apache knox Apache Knox List Topologies
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-topologies.listtopologies
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-knox-apache-knox-create
      description: Apache knox Apache Knox Create Topology
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: admin-topologies.createtopology
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-knox-apache-knox-get
      description: Apache knox Apache Knox Get Topology
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-topologies.gettopology
      with:
        topologyName: tools.topologyName
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-knox-apache-knox-delete
      description: Apache knox Apache Knox Delete Topology
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: admin-topologies.deletetopology
      with:
        topologyName: tools.topologyName
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-knox-apache-knox-get-2
      description: Apache knox Apache Knox Get Topology URLs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-topologies.gettopologyurls
      with:
        topologyName: tools.topologyName
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-knox-apache-knox-get-3
      description: Apache knox Apache Knox Get Version
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-topologies.getversion
      outputParameters:
      - type: object
        mapping: $.