Typesense Cloud Management API — Configuration Changes

naftiko: 1.0.0-alpha2
info:
  label: Typesense Cloud Management API — Configuration Changes
  description: 'Typesense Cloud Management API — Configuration Changes. 4 operations. Lead operation: Schedule A Configuration
    Change. Self-contained Naftiko capability covering one Typesense business surface.'
  tags:
  - Typesense
  - Configuration Changes
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TYPESENSE_API_KEY: TYPESENSE_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloud-management-configuration-changes
    baseUri: https://cloud.typesense.org/api/v1
    description: Typesense Cloud Management API — Configuration Changes business capability. Self-contained, no shared references.
    resources:
    - name: clusters-clusterId-configuration-changes
      path: /clusters/{clusterId}/configuration-changes
      operations:
      - name: createconfigurationchange
        method: POST
        description: Schedule A Configuration Change
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listconfigurationchanges
        method: GET
        description: List Configuration Changes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: per_page
          in: query
          type: integer
          description: Number of results per page.
    - name: clusters-clusterId-configuration-changes-changeId
      path: /clusters/{clusterId}/configuration-changes/{changeId}
      operations:
      - name: getconfigurationchange
        method: GET
        description: Retrieve A Configuration Change
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateconfigurationchange
        method: PATCH
        description: Cancel A Configuration Change
        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-TYPESENSE-CLOUD-MANAGEMENT-API-KEY
      value: '{{env.TYPESENSE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: cloud-management-configuration-changes-rest
    port: 8080
    description: REST adapter for Typesense Cloud Management API — Configuration Changes. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/clusters/{clusterid}/configuration-changes
      name: clusters-clusterid-configuration-changes
      description: REST surface for clusters-clusterId-configuration-changes.
      operations:
      - method: POST
        name: createconfigurationchange
        description: Schedule A Configuration Change
        call: cloud-management-configuration-changes.createconfigurationchange
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listconfigurationchanges
        description: List Configuration Changes
        call: cloud-management-configuration-changes.listconfigurationchanges
        with:
          per_page: rest.per_page
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/clusters/{clusterid}/configuration-changes/{changeid}
      name: clusters-clusterid-configuration-changes-changeid
      description: REST surface for clusters-clusterId-configuration-changes-changeId.
      operations:
      - method: GET
        name: getconfigurationchange
        description: Retrieve A Configuration Change
        call: cloud-management-configuration-changes.getconfigurationchange
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateconfigurationchange
        description: Cancel A Configuration Change
        call: cloud-management-configuration-changes.updateconfigurationchange
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cloud-management-configuration-changes-mcp
    port: 9090
    transport: http
    description: MCP adapter for Typesense Cloud Management API — Configuration Changes. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: schedule-configuration-change
      description: Schedule A Configuration Change
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cloud-management-configuration-changes.createconfigurationchange
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-configuration-changes
      description: List Configuration Changes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-management-configuration-changes.listconfigurationchanges
      with:
        per_page: tools.per_page
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-configuration-change
      description: Retrieve A Configuration Change
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-management-configuration-changes.getconfigurationchange
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-configuration-change
      description: Cancel A Configuration Change
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cloud-management-configuration-changes.updateconfigurationchange
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.