# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Conga Favorites API
  version: 1.0.0
extends: openapi/conga-favorites-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: 10
- target: $.paths['/favorites'].get
  update:
    x-apievangelist-phrasing:
      intent: List favorite configurations
      effect: read
      questions:
      - Which favorite configurations have been saved?
      - Can I filter and page through favorites?
      instructions:
      - text: List my favorite configurations.
      - text: List favorites matching filter {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/favorites'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete favorite records in bulk
      effect: destructive
      questions:
      - Can I delete several favorites in a single request?
      - How do I bulk-remove favorite configurations?
      instructions:
      - text: Bulk delete the selected favorite records.
      - text: Remove multiple favorites at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/favorites/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a favorite configuration (lowercase id path)
      effect: read
      questions:
      - Is there a separate lookup for a favorite configuration by identifier?
      - Which endpoint retrieves a favorite configuration via the lowercase id route?
      instructions:
      - text: Retrieve the favorite configuration {id} via the configuration lookup.
        slots:
          id: path.id
      - text: Get favorite configuration record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/favorites/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a favorite by ID
      effect: read
      questions:
      - How do I fetch a single favorite?
      - What does one saved favorite contain?
      instructions:
      - text: Fetch favorite {Id}.
        slots:
          Id: path.Id
      - text: Show me favorite {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/favorites/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a favorite
      effect: destructive
      questions:
      - Can I delete one favorite I saved?
      - Does removing a favorite affect carts it was added to?
      instructions:
      - text: Delete favorite {Id}.
        slots:
          Id: path.Id
      - text: Remove the favorite {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/favorites/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a favorite
      effect: write
      questions:
      - How do I change a saved favorite?
      - Can a favorite update run asynchronously?
      instructions:
      - text: Update favorite {Id}.
        slots:
          Id: path.Id
      - text: Update favorite {Id} for line numbers {lines} asynchronously.
        slots:
          Id: path.Id
          lines: query.line-numbers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/favorites/{Id}/addtocart/{cartId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a favorite to a cart
      effect: write
      questions:
      - Can I drop a saved favorite into a cart?
      - Is there a way to add a favorite without its adjustments?
      instructions:
      - text: Add favorite {Id} to cart {cart}.
        slots:
          Id: path.Id
          cart: path.cartId
      - text: Add favorite {Id} to cart {cart} excluding adjustments.
        slots:
          Id: path.Id
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/favorites/{Id}/items'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove line items from a favorite
      effect: destructive
      questions:
      - How do I clear the line items inside a favorite?
      - Can I keep a favorite but delete its items?
      instructions:
      - text: Delete the line items inside favorite {Id}.
        slots:
          Id: path.Id
      - text: Empty out the items of favorite {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/favorites/{Id}/preview'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview a favorite
      effect: read
      questions:
      - Can I preview what a favorite contains before using it?
      - Is there a preview for a favorite under a given config name?
      instructions:
      - text: Preview favorite {Id}.
        slots:
          Id: path.Id
      - text: Preview favorite {Id} with config {config}.
        slots:
          Id: path.Id
          config: query.configName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/favorites/{Id}/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a favorite to a price list
      effect: write
      questions:
      - How do I publish a favorite to a price list?
      - Can publishing a favorite run asynchronously?
      instructions:
      - text: Publish favorite {Id} to its price list.
        slots:
          Id: path.Id
      - text: Publish favorite {Id} to the pricelist asynchronously.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'