API Evangelist conversational phrasing for Workfront Record Types 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 Record Types API
  version: 1.0.0
extends: openapi/workfront-record-types-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: 10
- target: $.paths['/v1/record-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List a workspace's record types (legacy v1)
      effect: read
      questions:
      - Can the older v1 API list all record types in a workspace in one response?
      - If I can view a workspace, will the v1 list show me all its record types?
      instructions:
      - text: Using the v1 API, list the record types in workspace {workspaceId}.
        slots:
          workspaceId: query.workspaceId
      - text: Get v1 record types for workspace {workspaceId} with attributes {attributes}.
        slots:
          workspaceId: query.workspaceId
          attributes: query.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/record-types/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a record type with the legacy v1 endpoint
      effect: read
      questions:
      - Is there still a v1 endpoint to look up one record type by ID?
      - Can I choose which attributes come back for a record type on the v1 API?
      instructions:
      - text: Fetch record type {id} via the legacy v1 endpoint.
        slots:
          id: path.id
      - text: Get v1 record type {id} including only attributes {attributes}.
        slots:
          id: path.id
          attributes: query.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/record-types/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a record type by ID
      effect: read
      questions:
      - How do I see a record type's settings, primary field and permissions?
      - For a global record type, can I resolve its dynamic fields for a particular workspace?
      instructions:
      - text: Get record type {id}.
        slots:
          id: path.id
      - text: Show record type {id} with dynamic fields resolved for workspace {scopeWorkspaceId}.
        slots:
          id: path.id
          scopeWorkspaceId: query.scopeWorkspaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/record-types/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a record type's settings in full
      effect: write
      questions:
      - What happens to settings I leave out when I fully replace a record type?
      - Do I have to resend the display name every time I overwrite a record type?
      instructions:
      - text: Fully replace record type {id}, naming it {displayName} and clearing any setting not sent.
        slots:
          id: path.id
          displayName: requestBody.displayName
      - text: Overwrite record type {id} with display name {displayName}, description {description} and color {color}.
        slots:
          id: path.id
          displayName: requestBody.displayName
          description: requestBody.description
          color: requestBody.color
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/record-types/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a record type and its records
      effect: destructive
      questions:
      - Does deleting a record type also wipe out its fields and records?
      - Can I undo removing a record type after it's deleted?
      instructions:
      - text: Permanently delete record type {id} along with all its fields and records.
        slots:
          id: path.id
      - text: Remove record type {id} for good.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/record-types/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change some settings on a record type
      effect: write
      questions:
      - Can I just change a record type's icon without resending its other settings?
      - How do I tweak only the description of a record type?
      instructions:
      - text: 'Patch record type {id}: rename it to {displayName} and leave the rest unchanged.'
        slots:
          id: path.id
          displayName: requestBody.displayName
      - text: Partially update record type {id} to display name {displayName} with icon {icon}.
        slots:
          id: path.id
          displayName: requestBody.displayName
          icon: requestBody.icon
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/workspaces/{workspaceId}/record-types'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through a workspace's record types
      effect: read
      questions:
      - What record types exist in my workspace, page by page?
      - How many record types per page can the cursor-paginated listing return?
      instructions:
      - text: List record types in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Show the next {limit} record types in workspace {workspaceId} after cursor {cursor}.
        slots:
          limit: query.limit
          workspaceId: path.workspaceId
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/workspaces/{workspaceId}/record-types'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a record type in a workspace
      effect: write
      questions:
      - How do I add a new record type, like Campaigns, to a workspace?
      - Is there a cap on how many record types a workspace can have?
      - Can I attach an existing global record type to a workspace when creating one?
      instructions:
      - text: Create a record type called {displayName} in workspace {workspaceId}.
        slots:
          displayName: requestBody.displayName
          workspaceId: path.workspaceId
      - text: In workspace {workspaceId}, add record type {displayName} to section {sectionIndex}.
        slots:
          workspaceId: path.workspaceId
          displayName: requestBody.displayName
          sectionIndex: query.sectionIndex
      - text: Attach global record type {sourceRecordTypeId} to workspace {workspaceId} as {displayName}.
        slots:
          sourceRecordTypeId: requestBody.sourceRecordTypeId
          workspaceId: path.workspaceId
          displayName: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/workspaces/{workspaceId}/record-types/{recordTypeId}/detach'].post
  update:
    x-apievangelist-phrasing:
      intent: Detach a global record type from a workspace
      effect: destructive
      questions:
      - How do I stop a workspace from using a shared global record type?
      - If I detach a global record type, is its data kept?
      instructions:
      - text: Detach record type {recordTypeId} from workspace {workspaceId}.
        slots:
          recordTypeId: path.recordTypeId
          workspaceId: path.workspaceId
      - text: Remove workspace {workspaceId}'s link to global record type {recordTypeId} but keep its data.
        slots:
          workspaceId: path.workspaceId
          recordTypeId: path.recordTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/workspaces/{workspaceId}/global-record-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List global record types a workspace can attach
      effect: read
      questions:
      - Which shared global record types are available to add to my workspace?
      - Can I see the global record types I could attach before attaching one?
      instructions:
      - text: List global record types available to workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Show {limit} attachable global record types for workspace {workspaceId}.
        slots:
          limit: query.limit
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-10-01'