Kong · Capability

Konnect API - Go SDK — API Documentation

Konnect API - Go SDK — API Documentation. 6 operations. Lead operation: Create API Document. Self-contained Naftiko capability covering one Kong business surface.

Run with Naftiko KongAPI Documentation

What You Can Do

POST
Createapidocument — Create API Document
/v1/v3/apis/{apiid}/documents
GET
Listapidocuments — List API Documents
/v1/v3/apis/{apiid}/documents
GET
Fetchapidocument — Get an API Document
/v1/v3/apis/{apiid}/documents/{documentid}
PATCH
Updateapidocument — Update API Document
/v1/v3/apis/{apiid}/documents/{documentid}
DELETE
Deleteapidocument — Delete API Documentation
/v1/v3/apis/{apiid}/documents/{documentid}
POST
Moveapidocument — Move API Documentation
/v1/v3/apis/{apiid}/documents/{documentid}/move

MCP Tools

create-api-document

Create API Document

list-api-documents

List API Documents

read-only idempotent
get-api-document

Get an API Document

read-only idempotent
update-api-document

Update API Document

idempotent
delete-api-documentation

Delete API Documentation

idempotent
move-api-documentation

Move API Documentation

Capability Spec

konnect-platform-api-documentation.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Konnect API - Go SDK — API Documentation
  description: 'Konnect API - Go SDK — API Documentation. 6 operations. Lead operation: Create API Document. Self-contained
    Naftiko capability covering one Kong business surface.'
  tags:
  - Kong
  - API Documentation
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    KONG_API_KEY: KONG_API_KEY
capability:
  consumes:
  - type: http
    namespace: konnect-platform-api-documentation
    baseUri: https://global.api.konghq.com
    description: Konnect API - Go SDK — API Documentation business capability. Self-contained, no shared references.
    resources:
    - name: v3-apis-apiId-documents
      path: /v3/apis/{apiId}/documents
      operations:
      - name: createapidocument
        method: POST
        description: Create API Document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: listapidocuments
        method: GET
        description: List API Documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v3-apis-apiId-documents-documentId
      path: /v3/apis/{apiId}/documents/{documentId}
      operations:
      - name: fetchapidocument
        method: GET
        description: Get an API Document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateapidocument
        method: PATCH
        description: Update API Document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteapidocument
        method: DELETE
        description: Delete API Documentation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v3-apis-apiId-documents-documentId-move
      path: /v3/apis/{apiId}/documents/{documentId}/move
      operations:
      - name: moveapidocument
        method: POST
        description: Move API Documentation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.KONG_API_KEY}}'
  exposes:
  - type: rest
    namespace: konnect-platform-api-documentation-rest
    port: 8080
    description: REST adapter for Konnect API - Go SDK — API Documentation. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v3/apis/{apiid}/documents
      name: v3-apis-apiid-documents
      description: REST surface for v3-apis-apiId-documents.
      operations:
      - method: POST
        name: createapidocument
        description: Create API Document
        call: konnect-platform-api-documentation.createapidocument
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listapidocuments
        description: List API Documents
        call: konnect-platform-api-documentation.listapidocuments
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/apis/{apiid}/documents/{documentid}
      name: v3-apis-apiid-documents-documentid
      description: REST surface for v3-apis-apiId-documents-documentId.
      operations:
      - method: GET
        name: fetchapidocument
        description: Get an API Document
        call: konnect-platform-api-documentation.fetchapidocument
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateapidocument
        description: Update API Document
        call: konnect-platform-api-documentation.updateapidocument
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteapidocument
        description: Delete API Documentation
        call: konnect-platform-api-documentation.deleteapidocument
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/apis/{apiid}/documents/{documentid}/move
      name: v3-apis-apiid-documents-documentid-move
      description: REST surface for v3-apis-apiId-documents-documentId-move.
      operations:
      - method: POST
        name: moveapidocument
        description: Move API Documentation
        call: konnect-platform-api-documentation.moveapidocument
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: konnect-platform-api-documentation-mcp
    port: 9090
    transport: http
    description: MCP adapter for Konnect API - Go SDK — API Documentation. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: create-api-document
      description: Create API Document
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: konnect-platform-api-documentation.createapidocument
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-api-documents
      description: List API Documents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: konnect-platform-api-documentation.listapidocuments
      outputParameters:
      - type: object
        mapping: $.
    - name: get-api-document
      description: Get an API Document
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: konnect-platform-api-documentation.fetchapidocument
      outputParameters:
      - type: object
        mapping: $.
    - name: update-api-document
      description: Update API Document
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: konnect-platform-api-documentation.updateapidocument
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-api-documentation
      description: Delete API Documentation
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: konnect-platform-api-documentation.deleteapidocument
      outputParameters:
      - type: object
        mapping: $.
    - name: move-api-documentation
      description: Move API Documentation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: konnect-platform-api-documentation.moveapidocument
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.