Apache Helix REST API — State

naftiko: 1.0.0-alpha2
info:
  label: Apache Helix REST API — State
  description: 'Apache Helix REST API — State. 2 operations. Lead operation: Apache Helix Get External View. Self-contained
    Naftiko capability covering one Apache Helix business surface.'
  tags:
  - Apache Helix
  - State
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    APACHE_HELIX_API_KEY: APACHE_HELIX_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-state
    baseUri: http://localhost:9100
    description: Apache Helix REST API — State business capability. Self-contained, no shared references.
    resources:
    - name: clusters-clusterId-resources-resourceName-externalView
      path: /clusters/{clusterId}/resources/{resourceName}/externalView
      operations:
      - name: getexternalview
        method: GET
        description: Apache Helix Get External View
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: clusterId
          in: path
          type: string
          required: true
        - name: resourceName
          in: path
          type: string
          required: true
    - name: clusters-clusterId-resources-resourceName-idealState
      path: /clusters/{clusterId}/resources/{resourceName}/idealState
      operations:
      - name: getidealstate
        method: GET
        description: Apache Helix Get Ideal State
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: clusterId
          in: path
          type: string
          required: true
        - name: resourceName
          in: path
          type: string
          required: true
  exposes:
  - type: rest
    namespace: rest-state-rest
    port: 8080
    description: REST adapter for Apache Helix REST API — State. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/clusters/{clusterid}/resources/{resourcename}/externalview
      name: clusters-clusterid-resources-resourcename-externalview
      description: REST surface for clusters-clusterId-resources-resourceName-externalView.
      operations:
      - method: GET
        name: getexternalview
        description: Apache Helix Get External View
        call: rest-state.getexternalview
        with:
          clusterId: rest.clusterId
          resourceName: rest.resourceName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/clusters/{clusterid}/resources/{resourcename}/idealstate
      name: clusters-clusterid-resources-resourcename-idealstate
      description: REST surface for clusters-clusterId-resources-resourceName-idealState.
      operations:
      - method: GET
        name: getidealstate
        description: Apache Helix Get Ideal State
        call: rest-state.getidealstate
        with:
          clusterId: rest.clusterId
          resourceName: rest.resourceName
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-state-mcp
    port: 9090
    transport: http
    description: MCP adapter for Apache Helix REST API — State. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: apache-helix-get-external-view
      description: Apache Helix Get External View
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-state.getexternalview
      with:
        clusterId: tools.clusterId
        resourceName: tools.resourceName
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-helix-get-ideal-state
      description: Apache Helix Get Ideal State
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-state.getidealstate
      with:
        clusterId: tools.clusterId
        resourceName: tools.resourceName
      outputParameters:
      - type: object
        mapping: $.