# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Pirsch Short Links API
  version: 1.0.0
extends: openapi/pirsch-short-links-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/link'].get
  update:
    x-apievangelist-phrasing:
      intent: List a domain's short links
      effect: read
      questions:
      - Which short links have I created for my site?
      - Can I search my short links by name?
      instructions:
      - text: List the short links for domain {id}.
        slots:
          id: query.id
      - text: Find short links on domain {id} matching {search}.
        slots:
          id: query.id
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/link'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or edit a tracked short link
      effect: write
      questions:
      - How do I make a short link with UTM campaign tags for a newsletter?
      - Can a short link expire and redirect to another URL afterwards?
      - Is it possible to password-protect a short link?
      instructions:
      - text: Create a short link {name} on domain {domain_id} for {urls} with campaign {utm_campaign}.
        slots:
          name: requestBody.name
          domain_id: requestBody.domain_id
          urls: requestBody.urls
          utm_campaign: requestBody.utm_campaign
      - text: Update short link {id} on domain {domain_id} named {name} to expire at {expires_at}.
        slots:
          id: requestBody.id
          domain_id: requestBody.domain_id
          name: requestBody.name
          expires_at: requestBody.expires_at
      method: generated
      generated: '2026-10-01'
- target: $.paths['/link'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a short link
      effect: destructive
      questions:
      - How can I remove a short link I no longer want to work?
      - What happens to a short link's redirects once it's deleted?
      instructions:
      - text: Delete short link {id}.
        slots:
          id: query.id
      - text: Remove the short link {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'