# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Workfront Planning Records API
  version: 1.0.0
extends: openapi/adobe-suite-records-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: 6
- target: $.paths['/v1/records/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a record by ID
      effect: read
      questions:
      - What data does a specific Workfront Planning record hold?
      - Can I get a record back with field aliases instead of raw field IDs?
      instructions:
      - text: Show me record {id}.
        slots:
          id: path.id
      - text: Get record {id} with aliased set to {aliased} and attributes {attributes}.
        slots:
          id: path.id
          aliased: query.aliased
          attributes: query.attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/records/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a record
      effect: write
      questions:
      - How do I change the field values on an existing record?
      - Can I update a record's thumbnail or cover image?
      instructions:
      - text: Update record {id} with field data {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Set the cover image of record {id} to {coverImage}.
        slots:
          id: path.id
          coverImage: requestBody.coverImage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/records/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a record
      effect: destructive
      questions:
      - How do I permanently remove a record?
      - Can I delete one record by its ID?
      instructions:
      - text: Delete record {id}.
        slots:
          id: path.id
      - text: Remove the record with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/records'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a record
      effect: write
      questions:
      - How do I add a new record of a given record type?
      - Can I set a thumbnail when creating a record?
      instructions:
      - text: Create a record of type {recordTypeId} with data {data}.
        slots:
          recordTypeId: requestBody.recordTypeId
          data: requestBody.data
      - text: Add a new record of type {recordTypeId} with thumbnail {thumbnailUrl}.
        slots:
          recordTypeId: requestBody.recordTypeId
          thumbnailUrl: requestBody.thumbnailUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/records/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search records with query-string filters
      effect: read
      questions:
      - How do I find records of one type whose fields match certain values using a simple GET?
      - Can I page through record search results with offset and limit in the URL?
      instructions:
      - text: Search records of type {recordTypeId} via query string where {filters}.
        slots:
          recordTypeId: query.recordTypeId
          filters: query.filters
      - text: Using the GET search, fetch {limit} records from offset {offset} of type alias {recordTypeAlias}.
        slots:
          limit: query.limit
          offset: query.offset
          recordTypeAlias: query.recordTypeAlias
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/records/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search records with a filter and sort body
      effect: read
      questions:
      - Can I search records with sorting rules sent in a request body?
      - What's the way to run a complex record search with filters and grouping in a POST?
      instructions:
      - text: Run a POST record search on type {recordTypeId} with filters {filters} sorted by {sorting}.
        slots:
          recordTypeId: requestBody.recordTypeId
          filters: requestBody.filters
          sorting: requestBody.sorting
      - text: Search records grouped by fields {groupingFieldIds}, returning {limit} results in the body-based search.
        slots:
          groupingFieldIds: requestBody.groupingFieldIds
          limit: requestBody.limit
      method: generated
      generated: '2026-09-26'