Sideko API — Documentation

naftiko: 1.0.0-alpha2
info:
  label: Sideko API — Documentation
  description: 'Sideko API — Documentation. 2 operations. Lead operation: List Documentation Sites. Self-contained Naftiko
    capability covering one Sideko business surface.'
  tags:
  - Sideko
  - Documentation
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SIDEKO_API_KEY: SIDEKO_API_KEY
capability:
  consumes:
  - type: http
    namespace: sideko-documentation
    baseUri: https://api.sideko.dev/v1
    description: Sideko API — Documentation business capability. Self-contained, no shared references.
    resources:
    - name: api-projects-projectId-docs
      path: /api-projects/{projectId}/docs
      operations:
      - name: listdocumentationsites
        method: GET
        description: List Documentation Sites
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deploydocumentationsite
        method: POST
        description: Deploy Documentation Site
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: x-sideko-key
      value: '{{env.SIDEKO_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: sideko-documentation-rest
    port: 8080
    description: REST adapter for Sideko API — Documentation. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api-projects/{projectid}/docs
      name: api-projects-projectid-docs
      description: REST surface for api-projects-projectId-docs.
      operations:
      - method: GET
        name: listdocumentationsites
        description: List Documentation Sites
        call: sideko-documentation.listdocumentationsites
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: deploydocumentationsite
        description: Deploy Documentation Site
        call: sideko-documentation.deploydocumentationsite
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sideko-documentation-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sideko API — Documentation. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-documentation-sites
      description: List Documentation Sites
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sideko-documentation.listdocumentationsites
      outputParameters:
      - type: object
        mapping: $.
    - name: deploy-documentation-site
      description: Deploy Documentation Site
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sideko-documentation.deploydocumentationsite
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.