# 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 Check groups API
  version: 1.0.0
extends: openapi/checkly-check-groups-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: 11
- target: $.paths['/v1/check-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List check groups
      effect: read
      questions:
      - Which check groups exist in my Checkly account?
      - Can I find check groups carrying a particular tag?
      - Is there a way to look up a check group by its exact name?
      instructions:
      - text: List all my check groups.
      - text: Find check groups tagged {tag}.
        slots:
          tag: query.tag
      - text: Look up the check group named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/check-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a check group (v1)
      effect: write
      questions:
      - How do I create a group to share settings across checks using the v1 endpoint?
      - Can a new v1 check group run its checks in parallel across locations?
      instructions:
      - text: Create a check group {name} with the v1 endpoint.
        slots:
          name: requestBody.name
      - text: Using v1, create check group {name} running in {locations} with tags {tags}.
        slots:
          name: requestBody.name
          locations: requestBody.locations
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/check-groups/{groupId}/checks/{checkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a grouped check with group settings (v1)
      effect: read
      questions:
      - What does a check look like once its group's settings are applied, including project fields?
      - Can I see the effective config of one check inside a group via v1?
      instructions:
      - text: Show check {checkId} in group {groupId} with group settings applied, v1 format.
        slots:
          checkId: path.checkId
          groupId: path.groupId
      - text: Get the v1 effective settings for check {checkId} in check group {groupId}.
        slots:
          checkId: path.checkId
          groupId: path.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/check-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a check group
      effect: read
      questions:
      - What settings and locations does a specific check group use?
      - Which checks belong to a given check group?
      instructions:
      - text: Show check group {id}.
        slots:
          id: path.id
      - text: Get the configuration of check group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/check-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a check group (v1)
      effect: write
      questions:
      - How do I mute every check in a group at once with the v1 endpoint?
      - Can I deactivate a check group so none of its checks run, using v1?
      instructions:
      - text: Using v1, set check group {id} muted to {muted}.
        slots:
          id: path.id
          muted: requestBody.muted
      - text: Update check group {id} via v1 to run in {locations}.
        slots:
          id: path.id
          locations: requestBody.locations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/check-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a check group
      effect: destructive
      questions:
      - Can I delete a check group that still has checks in it?
      - How do I permanently remove an empty check group?
      instructions:
      - text: Delete check group {id}.
        slots:
          id: path.id
      - text: Permanently remove the empty check group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/check-groups/{id}/checks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's checks with settings applied (v1)
      effect: read
      questions:
      - What are the effective settings of all checks in one group, v1 style with project fields?
      - Can I page through every check in a group via the v1 endpoint?
      instructions:
      - text: List all checks in group {id} with group settings applied, v1 format.
        slots:
          id: path.id
      - text: Show page {page} of v1 checks in check group {id}.
        slots:
          page: query.page
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/check-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a check group (v2)
      effect: write
      questions:
      - How do I create a check group through the newer v2 endpoint?
      - Can a v2 check group inherit account-level alert settings?
      instructions:
      - text: Create check group {name} with the v2 endpoint.
        slots:
          name: requestBody.name
      - text: Using v2, create check group {name} with concurrency {concurrency} and runtime {runtimeId}.
        slots:
          name: requestBody.name
          concurrency: requestBody.concurrency
          runtimeId: requestBody.runtimeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/check-groups/{groupId}/checks/{checkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a grouped check with group settings (v2)
      effect: read
      questions:
      - How do I get a grouped check's effective settings without the flat project fields?
      - Can I see every project that manages one check inside a group?
      instructions:
      - text: Show check {checkId} in group {groupId} with group settings applied, v2 format.
        slots:
          checkId: path.checkId
          groupId: path.groupId
      - text: Get the v2 view of check {checkId} in group {groupId} including its projects.
        slots:
          checkId: path.checkId
          groupId: path.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/check-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a check group (v2)
      effect: write
      questions:
      - How do I update a check group with the v2 endpoint?
      - Does the v2 group update require the name every time?
      instructions:
      - text: Using v2, rename check group {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update check group {id} via v2 with name {name} and retry strategy {retryStrategy}.
        slots:
          id: path.id
          name: requestBody.name
          retryStrategy: requestBody.retryStrategy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/check-groups/{id}/checks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's checks with settings applied (v2)
      effect: read
      questions:
      - Can I list a group's checks with each managing project instead of flat project fields?
      - How do I page through a group's checks using the v2 endpoint?
      instructions:
      - text: List all checks in group {id} with group settings applied, v2 format.
        slots:
          id: path.id
      - text: Show v2 checks in check group {id}, {limit} per page.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-09-26'