# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Integrations Exception logs API
  version: 1.0.0
extends: openapi/sendcloud-exception-logs-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/integrations/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List exception logs across all integrations
      effect: read
      questions:
      - Why are my shop integrations failing to talk to my webshop?
      - Can I page through every integration's error log at once?
      instructions:
      - text: List exception logs for all my integrations.
      - text: Show the next {page_size} integration exception logs after cursor {cursor}.
        slots:
          page_size: query.page_size
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/integrations/{id}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List exception logs for one integration
      effect: read
      questions:
      - What errors has one specific shop integration hit recently?
      - How do I see the connection issue log for a single integration?
      instructions:
      - text: Show exception logs for integration {id}.
        slots:
          id: path.id
      - text: List the last {page_size} errors logged by integration {id}.
        slots:
          id: path.id
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/integrations/{id}/logs'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an exception log for an integration
      effect: write
      questions:
      - How can my integration report a failed shop request so the merchant sees it?
      - Which details can I attach when logging an integration exception?
      instructions:
      - text: Log an exception for integration {id} on request to {base_url}.
        slots:
          id: path.id
          base_url: requestBody.base_url
      - text: Record a {response_code} error from {base_url} against integration {id}.
        slots:
          id: path.id
          base_url: requestBody.base_url
          response_code: requestBody.response_code
      method: generated
      generated: '2026-10-01'