Apache Knox Admin REST API — Descriptors

naftiko: 1.0.0-alpha2
info:
  label: Apache Knox Admin REST API — Descriptors
  description: 'Apache Knox Admin REST API — Descriptors. 4 operations. Lead operation: Apache knox Apache Knox List Descriptors.
    Self-contained Naftiko capability covering one Apache Knox business surface.'
  tags:
  - Apache Knox
  - Descriptors
  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-descriptors
    baseUri: https://localhost:8443/gateway/admin
    description: Apache Knox Admin REST API — Descriptors business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-descriptors
      path: /api/v1/descriptors
      operations:
      - name: listdescriptors
        method: GET
        description: Apache knox Apache Knox List Descriptors
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createdescriptor
        method: POST
        description: Apache knox Apache Knox Create Descriptor
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-v1-descriptors-descriptorName
      path: /api/v1/descriptors/{descriptorName}
      operations:
      - name: getdescriptor
        method: GET
        description: Apache knox Apache Knox Get Descriptor
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: descriptorName
          in: path
          type: string
          required: true
      - name: deletedescriptor
        method: DELETE
        description: Apache knox Apache Knox Delete Descriptor
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: descriptorName
          in: path
          type: string
          required: true
    authentication:
      type: basic
      username: '{{env.APACHE_KNOX_USER}}'
      password: '{{env.APACHE_KNOX_PASS}}'
  exposes:
  - type: rest
    namespace: admin-descriptors-rest
    port: 8080
    description: REST adapter for Apache Knox Admin REST API — Descriptors. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v1/descriptors
      name: api-v1-descriptors
      description: REST surface for api-v1-descriptors.
      operations:
      - method: GET
        name: listdescriptors
        description: Apache knox Apache Knox List Descriptors
        call: admin-descriptors.listdescriptors
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createdescriptor
        description: Apache knox Apache Knox Create Descriptor
        call: admin-descriptors.createdescriptor
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/descriptors/{descriptorname}
      name: api-v1-descriptors-descriptorname
      description: REST surface for api-v1-descriptors-descriptorName.
      operations:
      - method: GET
        name: getdescriptor
        description: Apache knox Apache Knox Get Descriptor
        call: admin-descriptors.getdescriptor
        with:
          descriptorName: rest.descriptorName
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletedescriptor
        description: Apache knox Apache Knox Delete Descriptor
        call: admin-descriptors.deletedescriptor
        with:
          descriptorName: rest.descriptorName
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: admin-descriptors-mcp
    port: 9090
    transport: http
    description: MCP adapter for Apache Knox Admin REST API — Descriptors. 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 Descriptors
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-descriptors.listdescriptors
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-knox-apache-knox-create
      description: Apache knox Apache Knox Create Descriptor
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: admin-descriptors.createdescriptor
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-knox-apache-knox-get
      description: Apache knox Apache Knox Get Descriptor
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-descriptors.getdescriptor
      with:
        descriptorName: tools.descriptorName
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-knox-apache-knox-delete
      description: Apache knox Apache Knox Delete Descriptor
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: admin-descriptors.deletedescriptor
      with:
        descriptorName: tools.descriptorName
      outputParameters:
      - type: object
        mapping: $.