SAP HANA Cloud REST API — Alerts

naftiko: 1.0.0-alpha2
info:
  label: SAP HANA Cloud REST API — Alerts
  description: 'SAP HANA Cloud REST API — Alerts. 3 operations. Lead operation: List Alert Events for a Service Instance.
    Self-contained Naftiko capability covering one Sap Hana business surface.'
  tags:
  - Sap Hana
  - Alerts
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SAP_HANA_API_KEY: SAP_HANA_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloud-rest-alerts
    baseUri: https://api.cf.{region}.hana.ondemand.com
    description: SAP HANA Cloud REST API — Alerts business capability. Self-contained, no shared references.
    resources:
    - name: alerts-v1-serviceInstances-serviceInstanceId-events
      path: /alerts/v1/serviceInstances/{serviceInstanceId}/events
      operations:
      - name: listalertevents
        method: GET
        description: List Alert Events for a Service Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: alertState
          in: query
          type: string
          description: Filter alerts by their current state. Use Active to retrieve currently triggered alerts, or Resolved
            for previously triggered alerts that have returned to norma
        - name: severity
          in: query
          type: string
          description: Filter alerts by severity level. High severity alerts indicate critical conditions requiring immediate
            attention.
        - name: fromTimestamp
          in: query
          type: string
          description: Start timestamp for the alert event query window in ISO 8601 format. Only alerts triggered on or after
            this timestamp are returned.
        - name: toTimestamp
          in: query
          type: string
          description: End timestamp for the alert event query window in ISO 8601 format. Only alerts triggered on or before
            this timestamp are returned.
    - name: alerts-v1-serviceInstances-serviceInstanceId-rules
      path: /alerts/v1/serviceInstances/{serviceInstanceId}/rules
      operations:
      - name: listalertrules
        method: GET
        description: List Alert Rules for a Service Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatealertrules
        method: PATCH
        description: Update Alert Rules for a Service Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.SAP_HANA_API_KEY}}'
  exposes:
  - type: rest
    namespace: cloud-rest-alerts-rest
    port: 8080
    description: REST adapter for SAP HANA Cloud REST API — Alerts. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/alerts/v1/serviceinstances/{serviceinstanceid}/events
      name: alerts-v1-serviceinstances-serviceinstanceid-events
      description: REST surface for alerts-v1-serviceInstances-serviceInstanceId-events.
      operations:
      - method: GET
        name: listalertevents
        description: List Alert Events for a Service Instance
        call: cloud-rest-alerts.listalertevents
        with:
          alertState: rest.alertState
          severity: rest.severity
          fromTimestamp: rest.fromTimestamp
          toTimestamp: rest.toTimestamp
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/alerts/v1/serviceinstances/{serviceinstanceid}/rules
      name: alerts-v1-serviceinstances-serviceinstanceid-rules
      description: REST surface for alerts-v1-serviceInstances-serviceInstanceId-rules.
      operations:
      - method: GET
        name: listalertrules
        description: List Alert Rules for a Service Instance
        call: cloud-rest-alerts.listalertrules
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatealertrules
        description: Update Alert Rules for a Service Instance
        call: cloud-rest-alerts.updatealertrules
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cloud-rest-alerts-mcp
    port: 9090
    transport: http
    description: MCP adapter for SAP HANA Cloud REST API — Alerts. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-alert-events-service-instance
      description: List Alert Events for a Service Instance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-rest-alerts.listalertevents
      with:
        alertState: tools.alertState
        severity: tools.severity
        fromTimestamp: tools.fromTimestamp
        toTimestamp: tools.toTimestamp
      outputParameters:
      - type: object
        mapping: $.
    - name: list-alert-rules-service-instance
      description: List Alert Rules for a Service Instance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-rest-alerts.listalertrules
      outputParameters:
      - type: object
        mapping: $.
    - name: update-alert-rules-service-instance
      description: Update Alert Rules for a Service Instance
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cloud-rest-alerts.updatealertrules
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.