# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Swetrix Errors API
  version: 1.0.0
extends: openapi/swetrix-errors-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v1/log/errors'].get
  update:
    x-apievangelist-phrasing:
      intent: List grouped JavaScript errors for a project
      effect: read
      questions:
      - Which JavaScript errors are my visitors hitting most this week?
      - Can I page through error groups 150 at a time?
      instructions:
      - text: List error groups for project {pid} over {period}.
        slots:
          pid: query.pid
          period: query.period
      - text: Show the next {take} error groups for project {pid} over {period}, skipping {skip}.
        slots:
          take: query.take
          pid: query.pid
          period: query.period
          skip: query.skip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/log/get-error'].get
  update:
    x-apievangelist-phrasing:
      intent: View details of one error group
      effect: read
      questions:
      - What are the full details behind a specific error group?
      - Can I drill into one error by its ID to see its occurrences?
      instructions:
      - text: Get details for error {eid} in project {pid} over {period}.
        slots:
          eid: query.eid
          pid: query.pid
          period: query.period
      - text: Show me error group {eid} on project {pid} from {from} to {to} for period {period}.
        slots:
          eid: query.eid
          pid: query.pid
          from: query.from
          to: query.to
          period: query.period
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/log/error-overview'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart error counts over time
      effect: read
      questions:
      - Is my site's error rate going up or down over time?
      - How many errors happened per day across the whole project?
      instructions:
      - text: Chart error counts for project {pid} over {period} by {timeBucket}.
        slots:
          pid: query.pid
          period: query.period
          timeBucket: query.timeBucket
      - text: Get the error statistics overview for project {pid}, bucketed by {timeBucket}, for {period}.
        slots:
          pid: query.pid
          timeBucket: query.timeBucket
          period: query.period
      method: generated
      generated: '2026-09-26'
- target: $.paths['/log/error'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a JavaScript error from a page
      effect: write
      questions:
      - How do I send a caught JavaScript exception to Swetrix?
      - Can I include a stack trace and source file line when logging an error?
      - How are reported errors grouped together?
      instructions:
      - text: Record a {name} error with message {message} for project {pid}.
        slots:
          name: requestBody.name
          message: requestBody.message
          pid: requestBody.pid
      - text: Log error {name} from {filename} at line {lineno} for project {pid} with stack trace {stackTrace}.
        slots:
          name: requestBody.name
          filename: requestBody.filename
          lineno: requestBody.lineno
          pid: requestBody.pid
          stackTrace: requestBody.stackTrace
      method: generated
      generated: '2026-09-26'