SAP Commerce Cloud Admin API — Health

naftiko: 1.0.0-alpha2
info:
  label: SAP Commerce Cloud Admin API — Health
  description: 'SAP Commerce Cloud Admin API — Health. 3 operations. Lead operation: SAP Commerce Cloud Get system health
    status. Self-contained Naftiko capability covering one Sap Commerce Cloud business surface.'
  tags:
  - Sap Commerce Cloud
  - Health
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SAP_COMMERCE_CLOUD_API_KEY: SAP_COMMERCE_CLOUD_API_KEY
capability:
  consumes:
  - type: http
    namespace: admin-health
    baseUri: https://{tenant}.{region}.commercecloud.sap
    description: SAP Commerce Cloud Admin API — Health business capability. Self-contained, no shared references.
    resources:
    - name: monitoring-health
      path: /monitoring/health
      operations:
      - name: gethealthstatus
        method: GET
        description: SAP Commerce Cloud Get system health status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: monitoring-liveness
      path: /monitoring/liveness
      operations:
      - name: getlivenessstatus
        method: GET
        description: SAP Commerce Cloud Liveness probe
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: monitoring-readiness
      path: /monitoring/readiness
      operations:
      - name: getreadinessstatus
        method: GET
        description: SAP Commerce Cloud Readiness probe
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SAP_COMMERCE_CLOUD_API_KEY}}'
  exposes:
  - type: rest
    namespace: admin-health-rest
    port: 8080
    description: REST adapter for SAP Commerce Cloud Admin API — Health. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/monitoring/health
      name: monitoring-health
      description: REST surface for monitoring-health.
      operations:
      - method: GET
        name: gethealthstatus
        description: SAP Commerce Cloud Get system health status
        call: admin-health.gethealthstatus
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/monitoring/liveness
      name: monitoring-liveness
      description: REST surface for monitoring-liveness.
      operations:
      - method: GET
        name: getlivenessstatus
        description: SAP Commerce Cloud Liveness probe
        call: admin-health.getlivenessstatus
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/monitoring/readiness
      name: monitoring-readiness
      description: REST surface for monitoring-readiness.
      operations:
      - method: GET
        name: getreadinessstatus
        description: SAP Commerce Cloud Readiness probe
        call: admin-health.getreadinessstatus
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: admin-health-mcp
    port: 9090
    transport: http
    description: MCP adapter for SAP Commerce Cloud Admin API — Health. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: sap-commerce-cloud-get-system
      description: SAP Commerce Cloud Get system health status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-health.gethealthstatus
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-liveness-probe
      description: SAP Commerce Cloud Liveness probe
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-health.getlivenessstatus
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-readiness-probe
      description: SAP Commerce Cloud Readiness probe
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-health.getreadinessstatus
      outputParameters:
      - type: object
        mapping: $.