WSO2 API Manager - Developer Portal — API Documents

naftiko: 1.0.0-alpha2
info:
  label: WSO2 API Manager - Developer Portal — API Documents
  description: 'WSO2 API Manager - Developer Portal — API Documents. 3 operations. Lead operation: Get a List of Documents
    of an API. Self-contained Naftiko capability covering one Wso2 business surface.'
  tags:
  - Wso2
  - API Documents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WSO2_API_KEY: WSO2_API_KEY
capability:
  consumes:
  - type: http
    namespace: devportal-api-documents
    baseUri: https://apis.wso2.com/api/am/devportal/v3
    description: WSO2 API Manager - Developer Portal — API Documents business capability. Self-contained, no shared references.
    resources:
    - name: apis-apiId-documents
      path: /apis/{apiId}/documents
      operations:
      - name: get
        method: GET
        description: Get a List of Documents of an API
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: apis-apiId-documents-documentId
      path: /apis/{apiId}/documents/{documentId}
      operations:
      - name: get
        method: GET
        description: Get a Document of an API
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: apis-apiId-documents-documentId-content
      path: /apis/{apiId}/documents/{documentId}/content
      operations:
      - name: get
        method: GET
        description: Get the Content of an API Document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.WSO2_API_KEY}}'
  exposes:
  - type: rest
    namespace: devportal-api-documents-rest
    port: 8080
    description: REST adapter for WSO2 API Manager - Developer Portal — API Documents. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/apis/{apiid}/documents
      name: apis-apiid-documents
      description: REST surface for apis-apiId-documents.
      operations:
      - method: GET
        name: get
        description: Get a List of Documents of an API
        call: devportal-api-documents.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/apis/{apiid}/documents/{documentid}
      name: apis-apiid-documents-documentid
      description: REST surface for apis-apiId-documents-documentId.
      operations:
      - method: GET
        name: get
        description: Get a Document of an API
        call: devportal-api-documents.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/apis/{apiid}/documents/{documentid}/content
      name: apis-apiid-documents-documentid-content
      description: REST surface for apis-apiId-documents-documentId-content.
      operations:
      - method: GET
        name: get
        description: Get the Content of an API Document
        call: devportal-api-documents.get
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: devportal-api-documents-mcp
    port: 9090
    transport: http
    description: MCP adapter for WSO2 API Manager - Developer Portal — API Documents. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: get-list-documents-api
      description: Get a List of Documents of an API
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: devportal-api-documents.get
      outputParameters:
      - type: object
        mapping: $.
    - name: get-document-api
      description: Get a Document of an API
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: devportal-api-documents.get
      outputParameters:
      - type: object
        mapping: $.
    - name: get-content-api-document
      description: Get the Content of an API Document
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: devportal-api-documents.get
      outputParameters:
      - type: object
        mapping: $.