Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Userprefvalue API

7 actions 7 updates phrasing extends openapi/adobe-suite-userprefvalue-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 7

$.info
$.paths['/userprefvalue/{id}'].get
$.paths['/userprefvalue/{id}'].delete
$.paths['/userprefvalue'].get
$.paths['/userprefvalue'].post
$.paths['/userprefvalue'].delete
$.paths['/userprefvalue/search'].get

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 Userprefvalue API
  version: 1.0.0
extends: openapi/adobe-suite-userprefvalue-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['/userprefvalue/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one user preference value
      effect: read
      questions:
      - How do I read a single stored user preference value in Workfront?
      - Can I pick which fields come back for one preference value?
      instructions:
      - text: Show user preference value {id}.
        slots:
          id: path.id
      - text: Get preference value {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/userprefvalue/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one user preference value
      effect: destructive
      questions:
      - How do I clear a single saved user preference?
      - Can I force delete a preference value?
      instructions:
      - text: Delete user preference value {id}.
        slots:
          id: path.id
      - text: Force delete preference value {id} with force={force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/userprefvalue'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several user preference values by ID
      effect: read
      questions:
      - Can I retrieve a batch of user preference values by ID?
      - Which call returns multiple known preference values?
      instructions:
      - text: Fetch user preference values {id}.
        slots:
          id: query.id
      - text: Get preference values {id} showing only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/userprefvalue'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a new user preference value
      effect: write
      questions:
      - How do I store a new preference setting for a user?
      - Can I create a user preference value through the API?
      instructions:
      - text: Save a user preference value with the name and value I give.
      - text: Create a preference value and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/userprefvalue'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete many user preference values
      effect: destructive
      questions:
      - Can I bulk delete saved user preferences by ID?
      - Is there a way to clear several preference values at once?
      instructions:
      - text: Delete user preference values {id}.
        slots:
          id: query.id
      - text: Bulk force delete preference values {id} with force={force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/userprefvalue/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search user preference values
      effect: read
      questions:
      - How do I find the saved preferences for a particular user?
      - Can I search preference values with paging options?
      instructions:
      - text: Search user preference values where {filters}.
        slots:
          filters: query.filters
      - text: Find preference values matching {filters} with {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'