Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Customerpreferences API

8 actions 8 updates phrasing extends openapi/adobe-suite-customerpreferences-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/customerpreferences/{id}'].get
$.paths['/customerpreferences'].get
$.paths['/customerpreferences'].post
$.paths['/customerpreferences/search'].get
$.paths['/customerpreferences/getIsAutoUpgradeDisabled'].put
$.paths['/customerpreferences/getTimesheetPreferences'].put
$.paths['/customerpreferences/setTimesheetPreferences'].put

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Workfront Customerpreferences API
  version: 1.0.0
extends: openapi/adobe-suite-customerpreferences-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: 7
- target: $.paths['/customerpreferences/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer preference record by ID
      effect: read
      questions:
      - What value is stored in a specific Workfront customer preference?
      - Can I pick which fields return for one customer preference?
      instructions:
      - text: Show me customer preference {id}.
        slots:
          id: path.id
      - text: Get customer preference {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customerpreferences'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several customer preferences by ID
      effect: read
      questions:
      - Can I load multiple customer preference records at once?
      - What's the call for fetching customer preferences from a list of IDs?
      instructions:
      - text: Get customer preferences {id}.
        slots:
          id: query.id
      - text: Load customer preferences {id} together, including {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customerpreferences'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer preference
      effect: write
      questions:
      - How do I add a new customer-level preference setting?
      - Can I create a customer preference record via the API?
      instructions:
      - text: Create a customer preference with this name and value.
      - text: Add a new customer preference and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customerpreferences/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search customer preferences
      effect: read
      questions:
      - How do I find customer preferences by name?
      - Can I page through customer preference search results?
      instructions:
      - text: Search customer preferences where {filters}.
        slots:
          filters: query.filters
      - text: Find customer preferences matching {filters}, returning {fields} with list options {listOptions}.
        slots:
          filters: query.filters
          fields: query.fields
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customerpreferences/getIsAutoUpgradeDisabled'].put
  update:
    x-apievangelist-phrasing:
      intent: Check whether auto-upgrade is disabled
      effect: read
      questions:
      - Is automatic upgrading turned off for our Workfront customer?
      - Can I check the auto-upgrade setting for my account?
      instructions:
      - text: Check whether auto-upgrade is disabled for our customer.
      - text: Tell me if automatic upgrades are switched off.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customerpreferences/getTimesheetPreferences'].put
  update:
    x-apievangelist-phrasing:
      intent: Get timesheet preferences
      effect: read
      questions:
      - What timesheet preferences are configured for our organization?
      - Can I read the current timesheet settings?
      instructions:
      - text: Get our timesheet preferences.
      - text: Show me the current timesheet settings for the customer.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customerpreferences/setTimesheetPreferences'].put
  update:
    x-apievangelist-phrasing:
      intent: Set timesheet preferences
      effect: write
      questions:
      - How do I change our organization's timesheet settings?
      - Can I update timesheet preferences in one call?
      instructions:
      - text: Set our timesheet preferences to {preferences}.
        slots:
          preferences: query.preferences
      - text: Update the timesheet settings with {preferences}.
        slots:
          preferences: query.preferences
      method: generated
      generated: '2026-09-26'