# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Close Custom Fields.custom Object API
  version: 1.0.0
extends: openapi/close-custom-fields-custom-object-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: 5
- target: $.paths['/custom_field/custom_object_type/'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom object custom fields
      effect: read
      questions:
      - Which fields are defined on our custom object types?
      - Can I list every custom object custom field?
      instructions:
      - text: List all custom object custom fields.
      - text: Show the fields defined on custom object types.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/custom_object_type/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a field to a custom object type
      effect: write
      questions:
      - How do I add a field to a custom object type?
      - Can a custom object field be required?
      instructions:
      - text: Create a new custom field on my custom object type.
      - text: Add a required text field to the custom object type.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/custom_object_type/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a custom object custom field
      effect: read
      questions:
      - What are the settings of a specific custom object field?
      - Can I retrieve one custom object custom field by id?
      instructions:
      - text: Fetch custom object custom field {id}.
        slots:
          id: path.id
      - text: Show the details of custom object field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/custom_object_type/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom object custom field
      effect: write
      questions:
      - Can I rename a custom object field or change its choice options?
      - Is it possible to allow multiple values on a custom object field?
      instructions:
      - text: Rename custom object field {id}.
        slots:
          id: path.id
      - text: Update the choices on custom object field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/custom_object_type/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom object custom field
      effect: destructive
      questions:
      - Are values lost when I delete a custom object field?
      - Can I remove a field from a custom object type?
      instructions:
      - text: Delete custom object field {id}.
        slots:
          id: path.id
      - text: Remove custom object custom field {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'