Asana · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Asana Custom Fields API

9 actions 9 updates phrasing extends openapi/asana-custom-fields-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Asana's API. It is a proposal applied on top of the contract, not a document Asana publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/custom_fields'].post
$.paths['/custom_fields/{custom_field_gid}'].get
$.paths['/custom_fields/{custom_field_gid}'].put
$.paths['/custom_fields/{custom_field_gid}'].delete
$.paths['/workspaces/{workspace_gid}/custom_fields'].get
$.paths['/custom_fields/{custom_field_gid}/enum_options'].post
$.paths['/custom_fields/{custom_field_gid}/enum_options/insert'].post
$.paths['/enum_options/{enum_option_gid}'].put

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Asana Custom Fields API
  version: 1.0.0
extends: openapi/asana-custom-fields-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: 8
- target: $.paths['/custom_fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom field in a workspace
      effect: write
      questions:
      - How do I define a new custom field like a dropdown or number?
      - Can a custom field be moved to another workspace after creation?
      instructions:
      - text: Create a custom field named {field} in my workspace.
        slots:
          field: requestBody.data
      - text: Define a new dropdown custom field with {definition}.
        slots:
          definition: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom_fields/{custom_field_gid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom field's definition
      effect: read
      questions:
      - What type and options does a custom field have?
      - Can I see a dropdown field's enum options?
      instructions:
      - text: Show the definition of custom field {field}.
        slots:
          field: path.custom_field_gid
      - text: Fetch custom field {field} and its options.
        slots:
          field: path.custom_field_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom_fields/{custom_field_gid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom field
      effect: write
      questions:
      - Can I rename a custom field or change its description?
      - Who can update a locked custom field?
      instructions:
      - text: Rename custom field {field} to {name}.
        slots:
          field: path.custom_field_gid
          name: requestBody.data
      - text: Update custom field {field} with {changes}.
        slots:
          field: path.custom_field_gid
          changes: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom_fields/{custom_field_gid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field
      effect: destructive
      questions:
      - Can I delete a custom field from my workspace?
      - Who is allowed to delete a locked custom field?
      instructions:
      - text: Delete custom field {field}.
        slots:
          field: path.custom_field_gid
      - text: Remove the custom field {field} permanently.
        slots:
          field: path.custom_field_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace_gid}/custom_fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List a workspace's custom fields
      effect: read
      questions:
      - What custom fields exist in my workspace?
      - Can I page through all custom field definitions?
      instructions:
      - text: List the custom fields in workspace {workspace}.
        slots:
          workspace: path.workspace_gid
      - text: Show every field defined in workspace {workspace}.
        slots:
          workspace: path.workspace_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom_fields/{custom_field_gid}/enum_options'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an option to a dropdown custom field
      effect: write
      questions:
      - How do I add a new choice to a dropdown field?
      - Is there a limit to how many enum options a custom field can have?
      instructions:
      - text: Add option {option} to custom field {field}.
        slots:
          field: path.custom_field_gid
          option: requestBody.data
      - text: Create a new dropdown choice {option} on field {field}.
        slots:
          field: path.custom_field_gid
          option: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom_fields/{custom_field_gid}/enum_options/insert'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder a dropdown field's options
      effect: write
      questions:
      - Can I move a dropdown option before or after another one?
      - How do I change the order of enum choices?
      instructions:
      - text: Move an option in custom field {field} as {placement}.
        slots:
          field: path.custom_field_gid
          placement: requestBody.data
      - text: Reorder dropdown choices on field {field} using {placement}.
        slots:
          field: path.custom_field_gid
          placement: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/enum_options/{enum_option_gid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a dropdown option
      effect: write
      questions:
      - Can I rename, recolor or disable a single dropdown option?
      - Why must an enum field keep at least one enabled option?
      instructions:
      - text: Rename enum option {option} to {name}.
        slots:
          option: path.enum_option_gid
          name: requestBody.data
      - text: Disable dropdown option {option}.
        slots:
          option: path.enum_option_gid
      method: generated
      generated: '2026-10-01'