# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign REST Template Document Fields API
  version: 1.0.0
extends: openapi/docusign-templatedocumentfields-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: 4
- target: $.paths['/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: Get custom fields on a template document
      effect: read
      questions:
      - What custom document fields are defined on a template's document?
      - Can I read the metadata fields of a template document?
      instructions:
      - text: Get the custom fields on document {document} of template {template} in account {account}.
        slots:
          document: path.documentId
          template: path.templateId
          account: path.accountId
      - text: Show document fields for template {template}, document {document}, account {account}.
        slots:
          template: path.templateId
          document: path.documentId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields'].put
  update:
    x-apievangelist-phrasing:
      intent: Update custom fields on a template document
      effect: write
      questions:
      - How do I change existing custom field values on a template document?
      - Can I edit document fields stored in a template?
      instructions:
      - text: Update fields {fields} on document {document} in template {template}, account {account}.
        slots:
          fields: requestBody.documentFields
          document: path.documentId
          template: path.templateId
          account: path.accountId
      - text: Change the existing document field values of template {template} document {document} in account {account}.
        slots:
          template: path.templateId
          document: path.documentId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add custom fields to a template document
      effect: write
      questions:
      - Can I add new custom metadata fields to a template document?
      - How do I create document fields inside a template?
      instructions:
      - text: Add fields {fields} to document {document} in template {template}, account {account}.
        slots:
          fields: requestBody.documentFields
          document: path.documentId
          template: path.templateId
          account: path.accountId
      - text: Create new custom fields on template {template} document {document} for account {account}.
        slots:
          template: path.templateId
          document: path.documentId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove custom fields from a template document
      effect: destructive
      questions:
      - Can I delete custom fields from a template document?
      - How do I clear metadata fields off a document in a template?
      instructions:
      - text: Delete fields {fields} from document {document} in template {template}, account {account}.
        slots:
          fields: requestBody.documentFields
          document: path.documentId
          template: path.templateId
          account: path.accountId
      - text: Remove custom document fields from template {template} document {document} on account {account}.
        slots:
          template: path.templateId
          document: path.documentId
          account: path.accountId
      method: generated
      generated: '2026-10-01'