# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Encharge Custom Objects Schema API
  version: 1.0.0
extends: openapi/encharge-customobjectsschema-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['/schemas'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom object definitions
      effect: read
      questions:
      - What custom object types are defined in my account?
      - How do I list all the custom object schemas I've set up?
      instructions:
      - text: List all my custom object definitions.
      - text: Show every custom object type in the account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schemas'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new custom object type
      effect: write
      questions:
      - How do I create a new custom object type like Invoices?
      - Can I set a primary display field when defining a custom object?
      instructions:
      - text: Create a custom object named {name} shown as {displayNameSingular} / {displayNamePlural}.
        slots:
          name: requestBody.name
          displayNameSingular: requestBody.displayNameSingular
          displayNamePlural: requestBody.displayNamePlural
      - text: Define custom object {name} ({displayNameSingular}, {displayNamePlural}) with primary field {primaryField}.
        slots:
          name: requestBody.name
          displayNameSingular: requestBody.displayNameSingular
          displayNamePlural: requestBody.displayNamePlural
          primaryField: requestBody.primaryField
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schemas/{objectName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom object definition
      effect: read
      questions:
      - How do I see how a custom object type is defined?
      - What fields and display names does a given custom object schema have?
      instructions:
      - text: Show the definition of custom object {objectName}.
        slots:
          objectName: path.objectName
      - text: Get the schema for {objectName}.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schemas/{objectName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom object type and its data
      effect: destructive
      questions:
      - How do I remove a custom object type I no longer need?
      - Does deleting a custom object definition also wipe its stored records?
      instructions:
      - text: Delete the custom object type {objectName} and all its data.
        slots:
          objectName: path.objectName
      - text: Remove the {objectName} object definition.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schemas/{objectName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom object definition
      effect: write
      questions:
      - How do I change which fields are searchable on a custom object?
      - Can I rename the display names of a custom object type?
      instructions:
      - text: Make {searchableFields} searchable on custom object {objectName}.
        slots:
          searchableFields: requestBody.searchableFields
          objectName: path.objectName
      - text: Rename custom object {objectName} to display as {displayNamePlural}.
        slots:
          objectName: path.objectName
          displayNamePlural: requestBody.displayNamePlural
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schemas/{objectName}/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add fields to a custom object
      effect: write
      questions:
      - How do I add new fields to a custom object type?
      - Can I create several fields on a company object at once?
      instructions:
      - text: Add new fields to custom object {objectName}.
        slots:
          objectName: path.objectName
      - text: Create fields on the {objectName} schema.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schemas/{objectName}/fields/{fieldName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field from a custom object
      effect: destructive
      questions:
      - How do I remove a field from a custom object type?
      - Can I drop a field I added to my company object?
      instructions:
      - text: Delete field {fieldName} from custom object {objectName}.
        slots:
          fieldName: path.fieldName
          objectName: path.objectName
      - text: Remove the {fieldName} field on {objectName}.
        slots:
          fieldName: path.fieldName
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schemas/{objectName}/fields/{fieldName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a field on a custom object
      effect: write
      questions:
      - How do I change the label or tooltip of a custom object field?
      - Can I change a field's type on a custom object, or only on people fields?
      instructions:
      - text: Rename field {fieldName} on {objectName} to {title}.
        slots:
          fieldName: path.fieldName
          objectName: path.objectName
          title: requestBody.title
      - text: Set the tooltip of {objectName} field {fieldName} to {tooltip}.
        slots:
          objectName: path.objectName
          fieldName: path.fieldName
          tooltip: requestBody.tooltip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schemas/associations'].post
  update:
    x-apievangelist-phrasing:
      intent: Define an association between object types
      effect: write
      questions:
      - How do I set up a relationship between people and companies?
      - Can I make an association one-to-many or many-to-many?
      instructions:
      - text: Define a {type} association from {fromObject} to {toObject}.
        slots:
          type: requestBody.type
          fromObject: requestBody.fromObject
          toObject: requestBody.toObject
      - text: Create association {name} of type {type} between {fromObject} and {toObject}.
        slots:
          name: requestBody.name
          type: requestBody.type
          fromObject: requestBody.fromObject
          toObject: requestBody.toObject
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schemas/associations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an association definition
      effect: destructive
      questions:
      - How do I delete a relationship type I defined between two objects?
      - Can I remove an association schema altogether, not just one link?
      instructions:
      - text: Delete association definition {id}.
        slots:
          id: path.id
      - text: Remove the association schema {id} between object types.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'