Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Workfront Planning Record Types API

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

$.info
$.paths['/v1/record-types'].get
$.paths['/v1/record-types/{id}'].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 Workfront Planning Record Types API
  version: 1.0.0
extends: openapi/adobe-suite-record-types-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: 2
- target: $.paths['/v1/record-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List record types in a workspace
      effect: read
      questions:
      - Which record types are defined in a Workfront Planning workspace?
      - Can I include extra attributes when listing a workspace's record types?
      instructions:
      - text: List the record types in workspace {workspaceId}.
        slots:
          workspaceId: query.workspaceId
      - text: List record types for workspace {workspaceId} with attributes {attributes}.
        slots:
          workspaceId: query.workspaceId
          attributes: query.attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/record-types/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a record type by ID
      effect: read
      questions:
      - What fields and settings does a single record type have?
      - Can I look up one record type directly by its ID?
      instructions:
      - text: Get record type {id}.
        slots:
          id: path.id
      - text: Show record type {id} including {attributes}.
        slots:
          id: path.id
          attributes: query.attributes
      method: generated
      generated: '2026-09-26'