Health API

naftiko: 1.0.0-alpha2
info:
  label: Health API
  description: 'Health API. 2 operations. Lead operation: Health Check. Self-contained Naftiko capability covering one Open
    Policy Agent business surface.'
  tags:
  - Open Policy Agent
  - Health API
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OPEN_POLICY_AGENT_API_KEY: OPEN_POLICY_AGENT_API_KEY
capability:
  consumes:
  - type: http
    namespace: health
    baseUri: ''
    description: Health API business capability. Self-contained, no shared references.
    resources:
    - name: health
      path: /health
      operations:
      - name: get
        method: GET
        description: Health Check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: bundles
          in: query
          type: boolean
          description: Include bundle activation status in the health check.
        - name: plugins
          in: query
          type: boolean
          description: Include plugin status in the health check.
        - name: exclude-plugin
          in: query
          type: string
          description: Exclude specific plugins from the health check. Can be specified multiple times.
    - name: health-rule-name
      path: /health/{rule-name}
      operations:
      - name: get
        method: GET
        description: Custom Health Check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: rule-name
          in: path
          type: string
          description: Name of the rule to evaluate in the `system.health` package.
          required: true
  exposes:
  - type: rest
    namespace: health-rest
    port: 8080
    description: REST adapter for Health API. One Spectral-compliant resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/health
      name: health
      description: REST surface for health.
      operations:
      - method: GET
        name: get
        description: Health Check
        call: health.get
        with:
          bundles: rest.bundles
          plugins: rest.plugins
          exclude-plugin: rest.exclude-plugin
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/health/{rule-name}
      name: health-rule-name
      description: REST surface for health-rule-name.
      operations:
      - method: GET
        name: get
        description: Custom Health Check
        call: health.get
        with:
          rule-name: rest.rule-name
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: health-mcp
    port: 9090
    transport: http
    description: MCP adapter for Health API. One tool per consumed operation, routed inline through this capability's consumes
      block.
    tools:
    - name: health-check
      description: Health Check
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: health.get
      with:
        bundles: tools.bundles
        plugins: tools.plugins
        exclude-plugin: tools.exclude-plugin
      outputParameters:
      - type: object
        mapping: $.
    - name: custom-health-check
      description: Custom Health Check
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: health.get
      with:
        rule-name: tools.rule-name
      outputParameters:
      - type: object
        mapping: $.