# 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 field configurations API
  version: 1.0.0
extends: openapi/jira-issue-field-configurations-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: 15
- target: $.paths['/rest/api/3/fieldconfiguration'].get
  update:
    x-apievangelist-phrasing:
      intent: List field configurations
      effect: read
      questions:
      - Which field configurations exist in my Jira site?
      - Can I list only the default field configuration, or search them by name?
      instructions:
      - text: List all field configurations.
      - text: Find field configurations whose name or description contains {query}.
        slots:
          query: query.query
      - text: Show only the default field configuration where isDefault is {isDefault}.
        slots:
          isDefault: query.isDefault
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/fieldconfiguration'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a field configuration
      effect: write
      questions:
      - How do I create a new field configuration in company-managed Jira?
      - What do I need to supply to add a field configuration?
      instructions:
      - text: Create a field configuration named {name}.
        slots:
          name: requestBody.name
      - text: Add field configuration {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/fieldconfiguration/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a field configuration
      effect: write
      questions:
      - How do I rename an existing field configuration?
      - Can I change the description of a field configuration I already have?
      instructions:
      - text: Rename field configuration {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update field configuration {id} with name {name} and description {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/fieldconfiguration/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field configuration
      effect: destructive
      questions:
      - Can I delete a field configuration that is no longer used?
      - Which field configurations am I not allowed to delete?
      instructions:
      - text: Delete field configuration {id}.
        slots:
          id: path.id
      - text: Remove the unused field configuration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/fieldconfiguration/{id}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List the fields in a field configuration
      effect: read
      questions:
      - Which fields are hidden or required in a given field configuration?
      - How do I see the per-field settings inside a field configuration?
      instructions:
      - text: List the fields in field configuration {id}.
        slots:
          id: path.id
      - text: Show required and hidden settings for fields in configuration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/fieldconfiguration/{id}/fields'].put
  update:
    x-apievangelist-phrasing:
      intent: Change field settings in a field configuration
      effect: write
      questions:
      - How do I make a field required or hidden within a field configuration?
      - Can I change a field's renderer or description in a field configuration?
      instructions:
      - text: Update fields {fieldConfigurationItems} in field configuration {id}.
        slots:
          fieldConfigurationItems: requestBody.fieldConfigurationItems
          id: path.id
      - text: Apply field settings {fieldConfigurationItems} to configuration {id}.
        slots:
          fieldConfigurationItems: requestBody.fieldConfigurationItems
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/fieldconfigurationscheme'].get
  update:
    x-apievangelist-phrasing:
      intent: List field configuration schemes
      effect: read
      questions:
      - What field configuration schemes are defined in my Jira instance?
      - Can I look up specific field configuration schemes by ID?
      instructions:
      - text: List all field configuration schemes.
      - text: Show field configuration scheme {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/fieldconfigurationscheme'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a field configuration scheme
      effect: write
      questions:
      - How do I create a new field configuration scheme?
      - Is a name all I need to make a field configuration scheme?
      instructions:
      - text: Create a field configuration scheme named {name}.
        slots:
          name: requestBody.name
      - text: Add scheme {name} with description {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/fieldconfigurationscheme/mapping'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue type mappings in configuration schemes
      effect: read
      questions:
      - Which issue types map to which field configurations inside a scheme?
      - How do I see the issue type to field configuration items for a scheme?
      instructions:
      - text: Show issue type mappings for field configuration scheme {fieldConfigurationSchemeId}.
        slots:
          fieldConfigurationSchemeId: query.fieldConfigurationSchemeId
      - text: List every issue type to field configuration mapping across schemes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/fieldconfigurationscheme/project'].get
  update:
    x-apievangelist-phrasing:
      intent: Find field configuration schemes used by projects
      effect: read
      questions:
      - Which field configuration scheme is a given project using?
      - Can I check the field configuration schemes for several projects at once?
      instructions:
      - text: Show the field configuration scheme for project {projectId}.
        slots:
          projectId: query.projectId
      - text: Look up the field configuration schemes used by projects {projectId}.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/fieldconfigurationscheme/project'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign a field configuration scheme to a project
      effect: write
      questions:
      - How do I switch a project to a different field configuration scheme?
      - Can I put a project back on the default field configuration scheme?
      instructions:
      - text: Assign field configuration scheme {fieldConfigurationSchemeId} to project {projectId}.
        slots:
          fieldConfigurationSchemeId: requestBody.fieldConfigurationSchemeId
          projectId: requestBody.projectId
      - text: Reset project {projectId} to the default field configuration scheme.
        slots:
          projectId: requestBody.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/fieldconfigurationscheme/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a field configuration scheme
      effect: write
      questions:
      - How do I rename a field configuration scheme?
      - Can I update the description of an existing field configuration scheme?
      instructions:
      - text: Rename field configuration scheme {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update scheme {id} with name {name} and description {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/fieldconfigurationscheme/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field configuration scheme
      effect: destructive
      questions:
      - Can I delete a field configuration scheme that no project uses?
      - What happens if I try to remove a field configuration scheme?
      instructions:
      - text: Delete field configuration scheme {id}.
        slots:
          id: path.id
      - text: Remove the field configuration scheme {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/fieldconfigurationscheme/{id}/mapping'].put
  update:
    x-apievangelist-phrasing:
      intent: Map issue types to field configurations in a scheme
      effect: write
      questions:
      - How do I make bugs use a different field configuration within a scheme?
      - Can I set the default field configuration for a scheme's issue types?
      instructions:
      - text: Set mappings {mappings} on field configuration scheme {id}.
        slots:
          mappings: requestBody.mappings
          id: path.id
      - text: Assign issue types to field configurations in scheme {id} using {mappings}.
        slots:
          id: path.id
          mappings: requestBody.mappings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/fieldconfigurationscheme/{id}/mapping/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove issue types from a field configuration scheme
      effect: destructive
      questions:
      - How do I drop issue type mappings from a field configuration scheme?
      - Can I unmap several issue types from a scheme in one call?
      instructions:
      - text: Remove issue types {issueTypeIds} from field configuration scheme {id}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          id: path.id
      - text: Unmap {issueTypeIds} from scheme {id}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          id: path.id
      method: generated
      generated: '2026-09-26'