# 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 Private locations API
  version: 1.0.0
extends: openapi/checkly-private-locations-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: 8
- target: $.paths['/v1/private-locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List private locations
      effect: read
      questions:
      - Which private locations have I set up to run checks inside my network?
      - Can I see agent versions for my private locations?
      instructions:
      - text: List all my private locations.
      - text: List private locations including agent versions {versions}.
        slots:
          versions: query.versions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/private-locations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a private location
      effect: write
      questions:
      - How do I run checks from inside my own infrastructure?
      - Can a private location route API check calls through a proxy?
      instructions:
      - text: Create private location {name} with slug {slugName}.
        slots:
          name: requestBody.name
          slugName: requestBody.slugName
      - text: Add private location {name} ({slugName}) that sends API checks through proxy {proxyUrl}.
        slots:
          name: requestBody.name
          slugName: requestBody.slugName
          proxyUrl: requestBody.proxyUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/private-locations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a private location
      effect: read
      questions:
      - What are the details and keys of a specific private location?
      - Is a given private location configured with a proxy?
      instructions:
      - text: Show private location {id}.
        slots:
          id: path.id
      - text: Get the configuration of private location {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/private-locations/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a private location
      effect: write
      questions:
      - Can I rename a private location or change its proxy?
      - How do I change the icon of a private location?
      instructions:
      - text: Rename private location {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set private location {id} (name {name}) to use proxy {proxyUrl}.
        slots:
          id: path.id
          name: requestBody.name
          proxyUrl: requestBody.proxyUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/private-locations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a private location
      effect: destructive
      questions:
      - How do I decommission a private location I no longer use?
      - Is removing a private location permanent?
      instructions:
      - text: Delete private location {id}.
        slots:
          id: path.id
      - text: Permanently remove private location {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/private-locations/{id}/keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate an API key for a private location
      effect: write
      questions:
      - How do I get a new key for my private location agent?
      - Can I rotate a private location's API key by issuing a new one?
      instructions:
      - text: Generate a new API key for private location {id}.
        slots:
          id: path.id
      - text: Issue another agent key on private location {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/private-locations/{id}/keys/{keyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a private location API key
      effect: destructive
      questions:
      - How do I revoke a leaked private location key?
      - Can I delete an old key after rotating my private location agent?
      instructions:
      - text: Revoke key {keyId} on private location {id}.
        slots:
          keyId: path.keyId
          id: path.id
      - text: Delete API key {keyId} from private location {id}.
        slots:
          keyId: path.keyId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/private-locations/{id}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get health metrics for a private location
      effect: read
      questions:
      - Is my private location healthy over the last few days?
      - How far back can I pull private location health metrics?
      - Is there a daily limit on private location metrics requests?
      instructions:
      - text: Show health metrics for private location {id} from {from} to {to}.
        slots:
          id: path.id
          from: query.from
          to: query.to
      - text: Get private location {id} agent health between {from} and {to}.
        slots:
          id: path.id
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'