# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Scope3 Supply Requests API
  version: 1.0.0
extends: openapi/scope3-supply-requests-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: 4
- target: $.paths['/supply-requests/suggestions'].get
  update:
    x-apievangelist-phrasing:
      intent: Search publisher domains to request as supply
      effect: read
      questions:
      - Which seller or publisher domains match a name I want to request?
      - Can I search the registry before filing a supply request?
      instructions:
      - text: Suggest supply domains matching {q}.
        slots:
          q: query.q
      - text: Find up to {limit} publisher domains like {q}.
        slots:
          limit: query.limit
          q: query.q
      method: generated
      generated: '2026-10-01'
- target: $.paths['/supply-requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List my requested supply
      effect: read
      questions:
      - Which publishers have we already asked to be added as supply?
      - Can I see all our outstanding supply requests?
      instructions:
      - text: List my supply requests.
      - text: Show my first {limit} requested supply entries.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/supply-requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a new supply source
      effect: write
      questions:
      - How do I ask for a publisher I want to buy from to be added?
      - Can I give a launch date and geo with a supply request?
      instructions:
      - text: Request supply from {domain} on channel {channel}.
        slots:
          domain: requestBody.domain
          channel: requestBody.channel
      - text: Request {domain} for {channel} in {geo} launching {launchDate}.
        slots:
          domain: requestBody.domain
          channel: requestBody.channel
          geo: requestBody.geo
          launchDate: requestBody.launchDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/supply-requests/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Withdraw a supply request
      effect: destructive
      questions:
      - Can I take back a supply request I filed?
      - How do I drop a domain and channel from my asks?
      instructions:
      - text: Remove my supply request for {domain} on {channel}.
        slots:
          domain: requestBody.domain
          channel: requestBody.channel
      - text: Withdraw the {channel} request for {domain}.
        slots:
          channel: requestBody.channel
          domain: requestBody.domain
      method: generated
      generated: '2026-10-01'