# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salesforce Favorite API
  version: 1.0.0
extends: openapi/salesforce-favorite-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: 3
- target: $.paths['/data/v64.0/ui-api/favorites/{FAVORITE_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one favorite
      effect: read
      questions:
      - What does a single saved favorite point to?
      - Can I read one favorite's name and sort order?
      instructions:
      - text: Get favorite {favorite_id}.
        slots:
          favorite_id: path.FAVORITE_ID
      - text: Show the details of the favorite with ID {favorite_id}.
        slots:
          favorite_id: path.FAVORITE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/favorites/{FAVORITE_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or reorder a favorite
      effect: write
      questions:
      - How do I rename one of my favorites?
      - Can I move a single favorite to a different position?
      instructions:
      - text: Rename favorite {favorite_id} to {name}.
        slots:
          favorite_id: path.FAVORITE_ID
          name: requestBody.name
      - text: Move favorite {favorite_id} to position {sort_order}.
        slots:
          favorite_id: path.FAVORITE_ID
          sort_order: requestBody.sortOrder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/favorites/{FAVORITE_ID}/usage'].patch
  update:
    x-apievangelist-phrasing:
      intent: Record a click on a favorite
      effect: write
      questions:
      - Can I record that a favorite was just clicked so its usage stats update?
      - What updates the last-clicked time and click count of a favorite?
      instructions:
      - text: Record a click on favorite {favorite_id}.
        slots:
          favorite_id: path.FAVORITE_ID
      - text: Bump the usage count and last-used time of favorite {favorite_id}.
        slots:
          favorite_id: path.FAVORITE_ID
      method: generated
      generated: '2026-09-26'