# 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 Snippets API
  version: 1.0.0
extends: openapi/checkly-snippets-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/snippets'].get
  update:
    x-apievangelist-phrasing:
      intent: List code snippets
      effect: read
      questions:
      - Which reusable code snippets exist in my account?
      - Can I page through my snippets?
      instructions:
      - text: List all my snippets.
      - text: Show page {page} of snippets with {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/snippets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a code snippet
      effect: write
      questions:
      - How do I save a reusable script to share across checks?
      - What does a new snippet need besides its name?
      instructions:
      - text: Create snippet {name} with script {script}.
        slots:
          name: requestBody.name
          script: requestBody.script
      - text: Save a new reusable snippet called {name} containing {script}.
        slots:
          name: requestBody.name
          script: requestBody.script
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/snippets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a code snippet
      effect: read
      questions:
      - What code is in a specific snippet?
      - Can I view one snippet by its ID?
      instructions:
      - text: Show snippet {id}.
        slots:
          id: path.id
      - text: Get the script of snippet {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/snippets/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a code snippet
      effect: write
      questions:
      - Can I edit the code of an existing snippet?
      - Is it possible to rename a snippet?
      instructions:
      - text: Update snippet {id} to name {name} and script {script}.
        slots:
          id: path.id
          name: requestBody.name
          script: requestBody.script
      - text: Replace the code of snippet {id} with {script}, keeping name {name}.
        slots:
          id: path.id
          script: requestBody.script
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/snippets/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a code snippet
      effect: destructive
      questions:
      - How do I remove a snippet I no longer need?
      - Is deleting a snippet permanent?
      instructions:
      - text: Delete snippet {id}.
        slots:
          id: path.id
      - text: Permanently remove snippet {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'