# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Remote Files Custom Fields API
  version: 1.0.0
extends: openapi/remote-com-custom-fields-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: 4
- target: $.paths['/custom_fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions
      effect: read
      questions:
      - What custom fields have we defined for employees?
      - Can I list custom field definitions for just one scope?
      instructions:
      - text: List all custom field definitions.
      - text: Show custom field definitions in scope {scope}.
        slots:
          scope: query.scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new custom field
      effect: write
      questions:
      - How do I add a custom field like cost center to employee records?
      - Can a custom field be required or limited to a list of options?
      instructions:
      - text: Create a {type} custom field named {name} in scope {scope}.
        slots:
          type: requestBody.type
          name: requestBody.name
          scope: requestBody.scope
      - text: Add a required custom field {name} of type {type} for {scope} with options {options}.
        slots:
          name: requestBody.name
          type: requestBody.type
          scope: requestBody.scope
          options: requestBody.options
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_fields/{custom_field_id}/values'].get
  update:
    x-apievangelist-phrasing:
      intent: List values stored in a custom field
      effect: read
      questions:
      - What values have been filled in for a custom field across employees?
      - How do I see one person's value for a custom field?
      instructions:
      - text: List the values of custom field {custom_field_id}.
        slots:
          custom_field_id: path.custom_field_id
      - text: Show the value of custom field {custom_field_id} for {subject_id}.
        slots:
          custom_field_id: path.custom_field_id
          subject_id: query.subject_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_fields/{custom_field_id}/values'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a custom field value for a record
      effect: write
      questions:
      - How do I set or overwrite a custom field value for an employee?
      - Can I write a value into a custom field for one subject?
      instructions:
      - text: Set custom field {custom_field_id} to {value} for {subject_id}.
        slots:
          custom_field_id: path.custom_field_id
          value: requestBody.value
          subject_id: requestBody.subject_id
      - text: Save {value} in custom field {custom_field_id} on record {subject_id}.
        slots:
          value: requestBody.value
          custom_field_id: path.custom_field_id
          subject_id: requestBody.subject_id
      method: generated
      generated: '2026-09-26'