Open Liberty Admin REST API — Health

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