Open Liberty APIs — Health

naftiko: 1.0.0-alpha2
info:
  label: Open Liberty APIs — Health
  description: 'Open Liberty APIs — Health. 4 operations. Lead operation: Get Overall Health Status. Self-contained Naftiko
    capability covering one Websphere business surface.'
  tags:
  - Websphere
  - Health
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WEBSPHERE_API_KEY: WEBSPHERE_API_KEY
capability:
  consumes:
  - type: http
    namespace: open-liberty-apis-health
    baseUri: https://localhost:9443
    description: Open Liberty APIs — Health business capability. Self-contained, no shared references.
    resources:
    - name: health
      path: /health
      operations:
      - name: getoverallhealth
        method: GET
        description: Get Overall Health Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: health-live
      path: /health/live
      operations:
      - name: getliveness
        method: GET
        description: Get Liveness Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: health-ready
      path: /health/ready
      operations:
      - name: getreadiness
        method: GET
        description: Get Readiness Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: health-started
      path: /health/started
      operations:
      - name: getstarted
        method: GET
        description: Get Startup Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.WEBSPHERE_API_KEY}}'
  exposes:
  - type: rest
    namespace: open-liberty-apis-health-rest
    port: 8080
    description: REST adapter for Open Liberty APIs — Health. 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: getoverallhealth
        description: Get Overall Health Status
        call: open-liberty-apis-health.getoverallhealth
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/health/live
      name: health-live
      description: REST surface for health-live.
      operations:
      - method: GET
        name: getliveness
        description: Get Liveness Status
        call: open-liberty-apis-health.getliveness
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/health/ready
      name: health-ready
      description: REST surface for health-ready.
      operations:
      - method: GET
        name: getreadiness
        description: Get Readiness Status
        call: open-liberty-apis-health.getreadiness
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/health/started
      name: health-started
      description: REST surface for health-started.
      operations:
      - method: GET
        name: getstarted
        description: Get Startup Status
        call: open-liberty-apis-health.getstarted
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: open-liberty-apis-health-mcp
    port: 9090
    transport: http
    description: MCP adapter for Open Liberty APIs — Health. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-overall-health-status
      description: Get Overall Health Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: open-liberty-apis-health.getoverallhealth
      outputParameters:
      - type: object
        mapping: $.
    - name: get-liveness-status
      description: Get Liveness Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: open-liberty-apis-health.getliveness
      outputParameters:
      - type: object
        mapping: $.
    - name: get-readiness-status
      description: Get Readiness Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: open-liberty-apis-health.getreadiness
      outputParameters:
      - type: object
        mapping: $.
    - name: get-startup-status
      description: Get Startup Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: open-liberty-apis-health.getstarted
      outputParameters:
      - type: object
        mapping: $.