# 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.activity API
  version: 1.0.0
extends: openapi/close-custom-fields-activity-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/activity/'].get
  update:
    x-apievangelist-phrasing:
      intent: List activity custom fields
      effect: read
      questions:
      - Which custom fields are defined on our custom activities?
      - Can I see every activity custom field in the organization?
      instructions:
      - text: List all activity custom fields.
      - text: Show {limit} activity custom fields.
        slots:
          limit: query._limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/activity/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a field to a custom activity type
      effect: write
      questions:
      - How do I add a new field to a custom activity type?
      - Can an activity custom field be marked as required?
      instructions:
      - text: Create a new activity custom field on my custom activity type.
      - text: Add a required choices field to the demo custom activity.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/activity/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch an activity custom field
      effect: read
      questions:
      - What type and options does a specific activity custom field have?
      - Can I retrieve one activity custom field by id?
      instructions:
      - text: Fetch activity custom field {id}.
        slots:
          id: path.id
      - text: Show the options for activity custom field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/activity/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an activity custom field
      effect: write
      questions:
      - Can I rename an activity custom field or change its choices?
      - Is it possible to restrict editing of an activity field to certain roles?
      instructions:
      - text: Rename activity custom field {id}.
        slots:
          id: path.id
      - text: Make activity custom field {id} required.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_field/activity/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an activity custom field
      effect: destructive
      questions:
      - What happens to existing values when I delete an activity custom field?
      - Can I remove a field from a custom activity type?
      instructions:
      - text: Delete activity custom field {id}.
        slots:
          id: path.id
      - text: Remove activity custom field {id} and its values.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'