# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Checkly Public Status Pages V3 Components API
  version: 1.0.0
extends: openapi/checkly-status-pages-v3-components-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: 5
- target: $.paths['/v3/status-pages/{statusPageId}/components'].get
  update:
    x-apievangelist-phrasing:
      intent: List components on a v3 status page
      effect: read
      questions:
      - Which components appear on my status page and in what order?
      - Can I page through a status page's components?
      instructions:
      - text: List the components of status page {statusPageId}.
        slots:
          statusPageId: path.statusPageId
      - text: Show components of status page {statusPageId} after {nextId}.
        slots:
          statusPageId: path.statusPageId
          nextId: query.nextId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/components'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a component to a v3 status page
      effect: write
      questions:
      - How do I add a service or group component to my status page?
      - Can I nest a component under a group on my status page?
      instructions:
      - text: Add component {name} at position {displayOrder} to status page {statusPageId}.
        slots:
          name: requestBody.name
          displayOrder: requestBody.displayOrder
          statusPageId: path.statusPageId
      - text: Add {type} component {name} at position {displayOrder} on status page {statusPageId} under group {parentId}.
        slots:
          type: requestBody.type
          name: requestBody.name
          displayOrder: requestBody.displayOrder
          statusPageId: path.statusPageId
          parentId: requestBody.parentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/components/{componentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a v3 status page component
      effect: read
      questions:
      - What are the settings of one component on my status page?
      - Is a particular status page component hidden?
      instructions:
      - text: Show component {componentId} on status page {statusPageId}.
        slots:
          componentId: path.componentId
          statusPageId: path.statusPageId
      - text: Get status page {statusPageId} component {componentId}.
        slots:
          statusPageId: path.statusPageId
          componentId: path.componentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/components/{componentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a v3 status page component
      effect: write
      questions:
      - Will fields I omit be reset when I update a status page component?
      - How do I reorder or hide a component on my status page?
      instructions:
      - text: Update component {componentId} on status page {statusPageId} to name {name} at position {displayOrder}.
        slots:
          componentId: path.componentId
          statusPageId: path.statusPageId
          name: requestBody.name
          displayOrder: requestBody.displayOrder
      - text: 'Hide component {componentId} ({name}, position {displayOrder}) on status page {statusPageId}: set hidden to {hidden}.'
        slots:
          componentId: path.componentId
          name: requestBody.name
          displayOrder: requestBody.displayOrder
          statusPageId: path.statusPageId
          hidden: requestBody.hidden
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/components/{componentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a v3 status page component
      effect: destructive
      questions:
      - What happens to child components when I delete a group component?
      - How do I remove a component from my status page?
      instructions:
      - text: Delete component {componentId} from status page {statusPageId}.
        slots:
          componentId: path.componentId
          statusPageId: path.statusPageId
      - text: Remove status page {statusPageId} component {componentId}.
        slots:
          statusPageId: path.statusPageId
          componentId: path.componentId
      method: generated
      generated: '2026-09-26'