API Evangelist conversational phrasing for Workfront Planning API Version 2 Views API

# 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 API Version 2 Views API
  version: 1.0.0
extends: openapi/workfront-views-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: 6
- target: $.paths['/v2/views/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a view by ID
      effect: read
      questions:
      - How do I see the filters, grouping and sorting saved on a view?
      - What does a single timeline or table view's configuration look like?
      instructions:
      - text: Get view {id}.
        slots:
          id: path.id
      - text: Show the filter and sort settings saved on view {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/views/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a view's configuration in full
      effect: write
      questions:
      - What happens to view settings I leave out on a full replacement?
      - Must I resend a view's name and type every time I overwrite it?
      instructions:
      - text: Fully replace view {id} as {type} view {name}, clearing anything not sent.
        slots:
          id: path.id
          type: requestBody.type
          name: requestBody.name
      - text: Overwrite view {id} as {type} named {name} with filter {filter}.
        slots:
          id: path.id
          type: requestBody.type
          name: requestBody.name
          filter: requestBody.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/views/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a view
      effect: destructive
      questions:
      - How do I get rid of a saved view?
      - Can I delete a calendar or gallery view by its ID?
      instructions:
      - text: Delete view {id}.
        slots:
          id: path.id
      - text: Remove the saved view with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/views/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change some settings on a view
      effect: write
      questions:
      - Can I hide a view from the list without changing its filters?
      - Is there a way to turn on public link sharing for just one view?
      instructions:
      - text: Patch view {id} ({type}, {name}) to set hidden to {isHidden}.
        slots:
          id: path.id
          type: requestBody.type
          name: requestBody.name
          isHidden: requestBody.isHidden
      - text: Partially update view {id} named {name} of type {type} so public sharing is {isPublicShared}.
        slots:
          id: path.id
          name: requestBody.name
          type: requestBody.type
          isPublicShared: requestBody.isPublicShared
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/record-types/{recordTypeId}/views'].get
  update:
    x-apievangelist-phrasing:
      intent: List the views on a record type
      effect: read
      questions:
      - What saved views exist for a record type?
      - Can I page through a record type's views with a cursor?
      instructions:
      - text: List the views for record type {recordTypeId}.
        slots:
          recordTypeId: path.recordTypeId
      - text: Show the next {limit} views of record type {recordTypeId} after cursor {cursor}.
        slots:
          limit: query.limit
          recordTypeId: path.recordTypeId
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/record-types/{recordTypeId}/views'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a view for a record type
      effect: write
      questions:
      - How do I add a timeline or calendar view to a record type?
      - Is there a limit on personal views per record type?
      instructions:
      - text: Create a {type} view named {name} on record type {recordTypeId}.
        slots:
          type: requestBody.type
          name: requestBody.name
          recordTypeId: path.recordTypeId
      - text: Add a {type} view {name} to record type {recordTypeId} sorted by {sorting}.
        slots:
          type: requestBody.type
          name: requestBody.name
          recordTypeId: path.recordTypeId
          sorting: requestBody.sorting
      method: generated
      generated: '2026-10-01'