ForgeRock Directory Services API — Health

naftiko: 1.0.0-alpha2
info:
  label: ForgeRock Directory Services API — Health
  description: 'ForgeRock Directory Services API — Health. 2 operations. Lead operation: Health check. Self-contained Naftiko
    capability covering one Forgerock business surface.'
  tags:
  - Forgerock
  - Health
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FORGEROCK_API_KEY: FORGEROCK_API_KEY
capability:
  consumes:
  - type: http
    namespace: directory-services-health
    baseUri: https://{deployment}/ds
    description: ForgeRock Directory Services API — Health business capability. Self-contained, no shared references.
    resources:
    - name: alive
      path: /alive
      operations:
      - name: healthcheck
        method: GET
        description: Health check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: healthy
      path: /healthy
      operations:
      - name: detailedhealthcheck
        method: GET
        description: Detailed health check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.FORGEROCK_API_KEY}}'
  exposes:
  - type: rest
    namespace: directory-services-health-rest
    port: 8080
    description: REST adapter for ForgeRock Directory Services API — Health. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/alive
      name: alive
      description: REST surface for alive.
      operations:
      - method: GET
        name: healthcheck
        description: Health check
        call: directory-services-health.healthcheck
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/healthy
      name: healthy
      description: REST surface for healthy.
      operations:
      - method: GET
        name: detailedhealthcheck
        description: Detailed health check
        call: directory-services-health.detailedhealthcheck
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: directory-services-health-mcp
    port: 9090
    transport: http
    description: MCP adapter for ForgeRock Directory Services API — Health. 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: directory-services-health.healthcheck
      outputParameters:
      - type: object
        mapping: $.
    - name: detailed-health-check
      description: Detailed health check
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: directory-services-health.detailedhealthcheck
      outputParameters:
      - type: object
        mapping: $.