Encharge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Encharge Person Fields API

5 actions 5 updates phrasing extends openapi/encharge-personfields-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Encharge's API. It is a proposal applied on top of the contract, not a document Encharge publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/fields'].get

$.paths['/fields'].post

$.paths['/fields/{fieldName}'].delete

$.paths['/fields/{fieldName}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Encharge Person Fields API
  version: 1.0.0
extends: openapi/encharge-personfields-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['/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List person fields
      effect: read
      questions:
      - What person fields exist in my account?
      - How do I find the field names to use when updating contacts?
      instructions:
      - text: List all person fields.
      - text: Show every contact field defined in my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create person fields
      effect: write
      questions:
      - How do I add a new custom field to my contacts?
      - Can I create several person fields at once?
      instructions:
      - text: Create new person fields.
      - text: Add these custom fields to my contacts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fields/{fieldName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a person field
      effect: destructive
      questions:
      - How do I remove a custom field from my contacts?
      - Can I delete a person field I created by mistake?
      instructions:
      - text: Delete person field {fieldName}.
        slots:
          fieldName: path.fieldName
      - text: Remove the contact field {fieldName}.
        slots:
          fieldName: path.fieldName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fields/{fieldName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Modify a person field
      effect: write
      questions:
      - How do I change the type or format of a contact field?
      - Can I restrict a person field to a list of allowed values?
      instructions:
      - text: Change person field {fieldName} to name {name} and type {type}.
        slots:
          fieldName: path.fieldName
          name: requestBody.name
          type: requestBody.type
      - text: Set allowed values {enum} on contact field {fieldName} (name {name}, type {type}).
        slots:
          enum: requestBody.enum
          fieldName: path.fieldName
          name: requestBody.name
          type: requestBody.type
      method: generated
      generated: '2026-10-01'