API Evangelist conversational phrasing for Jira Cloud platform REST Issue custom field contexts API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST Issue custom field contexts API
  version: 1.0.0
extends: openapi/jira-issue-custom-field-contexts-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: 14
- target: $.paths['/rest/api/3/field/{fieldId}/context'].get
  update:
    x-apievangelist-phrasing:
      intent: List the contexts of a custom field
      effect: read
      questions:
      - What contexts are defined for a custom field?
      - Can I list only the global context of a custom field?
      instructions:
      - text: List the contexts for custom field {fieldId}.
        slots:
          fieldId: path.fieldId
      - text: Show custom field {fieldId} contexts where global context is {isGlobalContext}.
        slots:
          fieldId: path.fieldId
          isGlobalContext: query.isGlobalContext
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/field/{fieldId}/context'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a context for a custom field
      effect: write
      questions:
      - How do I create a new context for a custom field limited to certain projects?
      - What happens if I create a field context without any projects?
      instructions:
      - text: Create a context named {name} on custom field {fieldId}.
        slots:
          name: requestBody.name
          fieldId: path.fieldId
      - text: Add context {name} to field {fieldId} for projects {projectIds} and issue types {issueTypeIds}.
        slots:
          name: requestBody.name
          fieldId: path.fieldId
          projectIds: requestBody.projectIds
          issueTypeIds: requestBody.issueTypeIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/field/{fieldId}/context/defaultValue'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a custom field's contexts
      effect: read
      questions:
      - What default value does each context of my custom field use?
      - Can I see the default for just one context of a field?
      instructions:
      - text: Get the context default values for custom field {fieldId}.
        slots:
          fieldId: path.fieldId
      - text: Show the default value of context {contextId} on field {fieldId}.
        slots:
          contextId: query.contextId
          fieldId: path.fieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/field/{fieldId}/context/defaultValue'].put
  update:
    x-apievangelist-phrasing:
      intent: Set default values for a custom field's contexts
      effect: write
      questions:
      - How do I set a default value for a custom field in a context?
      - Can I set defaults for date, option and user custom fields?
      instructions:
      - text: Set the context defaults for custom field {fieldId} to {defaultValues}.
        slots:
          fieldId: path.fieldId
          defaultValues: requestBody.defaultValues
      - text: Update the default values {defaultValues} across contexts of field {fieldId}.
        slots:
          defaultValues: requestBody.defaultValues
          fieldId: path.fieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/field/{fieldId}/context/defaultValues'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a field's defaults grouped by context and issue type
      effect: read
      questions:
      - Can I see a custom field's default values broken down per issue type?
      - Which default applies to a given issue type within a field context?
      instructions:
      - text: List field {fieldId} default values grouped by context and issue type.
        slots:
          fieldId: path.fieldId
      - text: Show the per-issue-type default for issue type {issueTypeId} in context {contextId} of field {fieldId}.
        slots:
          issueTypeId: query.issueTypeId
          contextId: query.contextId
          fieldId: path.fieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/field/{fieldId}/context/issuetypemapping'].get
  update:
    x-apievangelist-phrasing:
      intent: List which issue types each field context covers
      effect: read
      questions:
      - Which issue types are mapped to each context of a custom field?
      - Can I check the issue type mappings for a single field context?
      instructions:
      - text: List the issue type mappings for contexts of field {fieldId}.
        slots:
          fieldId: path.fieldId
      - text: Show which issue types context {contextId} of field {fieldId} applies to.
        slots:
          contextId: query.contextId
          fieldId: path.fieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/field/{fieldId}/context/mapping'].post
  update:
    x-apievangelist-phrasing:
      intent: Find which field context applies to project/issue type pairs
      effect: read
      questions:
      - Which context of a custom field applies to a given project and issue type combination?
      - Can I look up the effective field context for several project and issue type pairs at once?
      instructions:
      - text: Find the context of field {fieldId} that applies to the project and issue type pairs {mappings}.
        slots:
          fieldId: path.fieldId
          mappings: requestBody.mappings
      - text: Look up which field {fieldId} context is in effect for {mappings}.
        slots:
          fieldId: path.fieldId
          mappings: requestBody.mappings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/field/{fieldId}/context/projectmapping'].get
  update:
    x-apievangelist-phrasing:
      intent: List which projects each field context covers
      effect: read
      questions:
      - Which projects is each context of a custom field assigned to?
      - Can I see the project mappings for one specific field context?
      instructions:
      - text: List the project mappings for contexts of field {fieldId}.
        slots:
          fieldId: path.fieldId
      - text: Show which projects context {contextId} of field {fieldId} is assigned to.
        slots:
          contextId: query.contextId
          fieldId: path.fieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a custom field context
      effect: write
      questions:
      - How do I rename an existing custom field context?
      - Can I change the description of a field context?
      instructions:
      - text: Rename context {contextId} on field {fieldId} to {name}.
        slots:
          contextId: path.contextId
          fieldId: path.fieldId
          name: requestBody.name
      - text: Set the description of context {contextId} on field {fieldId} to {description}.
        slots:
          contextId: path.contextId
          fieldId: path.fieldId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field context
      effect: destructive
      questions:
      - How do I delete a context from a custom field?
      - Can I still remove the global context of a field?
      instructions:
      - text: Delete context {contextId} from custom field {fieldId}.
        slots:
          contextId: path.contextId
          fieldId: path.fieldId
      - text: Remove field {fieldId}'s context {contextId} entirely.
        slots:
          fieldId: path.fieldId
          contextId: path.contextId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}/issuetype'].put
  update:
    x-apievangelist-phrasing:
      intent: Add issue types to a custom field context
      effect: write
      questions:
      - Can I extend a field context so it also covers more issue types?
      - What happens when I add issue types to a context that applied to all of them?
      instructions:
      - text: Add issue types {issueTypeIds} to context {contextId} of field {fieldId}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          contextId: path.contextId
          fieldId: path.fieldId
      - text: Append {issueTypeIds} to the issue types covered by field {fieldId} context {contextId}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          fieldId: path.fieldId
          contextId: path.contextId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove issue types from a custom field context
      effect: write
      questions:
      - How do I stop a field context from applying to certain issue types?
      - If I remove every issue type from a context, does it apply to all of them?
      instructions:
      - text: Remove issue types {issueTypeIds} from context {contextId} of field {fieldId}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          contextId: path.contextId
          fieldId: path.fieldId
      - text: Take {issueTypeIds} out of field {fieldId} context {contextId}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          fieldId: path.fieldId
          contextId: path.contextId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}/project'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign a custom field context to projects
      effect: write
      questions:
      - Can I assign a field context to additional projects?
      - Why does assigning a context fail if the project already uses another context of the field?
      instructions:
      - text: Assign context {contextId} of field {fieldId} to projects {projectIds}.
        slots:
          contextId: path.contextId
          fieldId: path.fieldId
          projectIds: requestBody.projectIds
      - text: Make projects {projectIds} use field {fieldId} context {contextId}.
        slots:
          projectIds: requestBody.projectIds
          fieldId: path.fieldId
          contextId: path.contextId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}/project/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Unassign a custom field context from projects
      effect: write
      questions:
      - How do I detach a field context from specific projects?
      - Does removing all projects from a context make it apply everywhere?
      instructions:
      - text: Remove context {contextId} of field {fieldId} from projects {projectIds}.
        slots:
          contextId: path.contextId
          fieldId: path.fieldId
          projectIds: requestBody.projectIds
      - text: Unassign projects {projectIds} from field {fieldId} context {contextId}.
        slots:
          projectIds: requestBody.projectIds
          fieldId: path.fieldId
          contextId: path.contextId
      method: generated
      generated: '2026-09-26'