# 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 Environment variables API
  version: 1.0.0
extends: openapi/checkly-environment-variables-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['/v1/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List environment variables
      effect: read
      questions:
      - Which account-level environment variables do I have defined?
      - Can I page through my environment variables?
      instructions:
      - text: List all my environment variables.
      - text: Show page {page} of environment variables, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/variables'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment variable
      effect: write
      questions:
      - How do I add a new environment variable that my checks can use?
      - Can I store a variable as a secret so its value is hidden?
      instructions:
      - text: Create environment variable {key} with value {value}.
        slots:
          key: requestBody.key
          value: requestBody.value
      - text: Add a secret environment variable {key} set to {value}.
        slots:
          key: requestBody.key
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/variables/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an environment variable
      effect: read
      questions:
      - What is the current value and settings of a specific environment variable?
      - Can I look up a variable by its key name?
      instructions:
      - text: Show environment variable {key}.
        slots:
          key: path.key
      - text: Get the details of variable {key}.
        slots:
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/variables/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an environment variable's value
      effect: write
      questions:
      - Can I change the value of an existing environment variable?
      - Once I mark a variable secret, can I make it non-secret again?
      instructions:
      - text: Set environment variable {key} to {value}.
        slots:
          key: path.key
          value: requestBody.value
      - text: 'Update variable {key} to {value} and lock it: {locked}.'
        slots:
          key: path.key
          value: requestBody.value
          locked: requestBody.locked
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/variables/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an environment variable
      effect: destructive
      questions:
      - How do I remove an environment variable I no longer use?
      - Is deleting an environment variable permanent?
      instructions:
      - text: Delete environment variable {key}.
        slots:
          key: path.key
      - text: Permanently remove variable {key}.
        slots:
          key: path.key
      method: generated
      generated: '2026-09-26'