API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Field…

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Field…
  version: 1.0.0
extends: openapi/atlassian-issue-field-configurations-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: 15
- target: $.paths['/rest/api/3/fieldconfiguration'].get
  update:
    x-apievangelist-phrasing:
      intent: List field configurations
      effect: read
      questions:
      - What field configurations exist in my Jira site?
      - Can I find 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 default field configurations: {isDefault}.'
        slots:
          isDefault: query.isDefault
      method: generated
      generated: '2026-10-01'
- 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 for a classic project?
      - Does a new field configuration start with every field optional?
      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-10-01'
- target: $.paths['/rest/api/3/fieldconfiguration/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a field configuration
      effect: write
      questions:
      - Can I rename an existing field configuration?
      - Is changing a field configuration's description limited to classic projects?
      instructions:
      - text: Rename field configuration {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set field configuration {id}'s name to {name} and description to {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/fieldconfiguration/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field configuration
      effect: destructive
      questions:
      - How do I remove a field configuration we no longer need?
      - Can field configurations from team-managed projects be deleted here?
      instructions:
      - text: Delete field configuration {id}.
        slots:
          id: path.id
      - text: Remove the unused field configuration {id} from Jira.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/fieldconfiguration/{id}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List fields in a field configuration
      effect: read
      questions:
      - Which fields are required or hidden in a particular field configuration?
      - What settings does each field have inside one field configuration?
      instructions:
      - text: List the fields and their settings in field configuration {id}.
        slots:
          id: path.id
      - text: Show {maxResults} fields from field configuration {id}.
        slots:
          maxResults: query.maxResults
          id: path.id
      method: generated
      generated: '2026-10-01'
- 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 in a field configuration?
      - Can I change a field's renderer or description within a configuration?
      instructions:
      - text: Update fields in field configuration {id} with {fieldConfigurationItems}.
        slots:
          id: path.id
          fieldConfigurationItems: requestBody.fieldConfigurationItems
      - text: Mark the fields in {fieldConfigurationItems} as required within field configuration {id}.
        slots:
          fieldConfigurationItems: requestBody.fieldConfigurationItems
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/fieldconfigurationscheme'].get
  update:
    x-apievangelist-phrasing:
      intent: List field configuration schemes
      effect: read
      questions:
      - What field configuration schemes are set up for classic projects?
      - Can I fetch specific field configuration schemes by ID?
      instructions:
      - text: List all field configuration schemes.
      - text: Get field configuration schemes with IDs {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'
- 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 field configuration scheme for company-managed projects?
      - Can I give a new field configuration scheme a description?
      instructions:
      - text: Create a field configuration scheme named {name}.
        slots:
          name: requestBody.name
      - text: Add field configuration scheme {name} with description {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/fieldconfigurationscheme/mapping'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue type to field configuration mappings
      effect: read
      questions:
      - Which field configuration does each issue type use in a scheme?
      - Can I see the issue type mappings for one field configuration scheme?
      instructions:
      - text: Show the issue type mappings in field configuration scheme {fieldConfigurationSchemeId}.
        slots:
          fieldConfigurationSchemeId: query.fieldConfigurationSchemeId
      - text: List all field configuration issue type items.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/fieldconfigurationscheme/project'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the field configuration scheme a project uses
      effect: read
      questions:
      - Which field configuration scheme is my project assigned to?
      - What projects share each field configuration scheme?
      instructions:
      - text: Get the field configuration scheme for project {projectId}.
        slots:
          projectId: query.projectId
      - text: Show field configuration schemes and the projects using them for projects {projectId}.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-10-01'
- 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 classic 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-10-01'
- target: $.paths['/rest/api/3/fieldconfigurationscheme/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a field configuration scheme
      effect: write
      questions:
      - Can I rename a field configuration scheme after creating it?
      - How do I change the description on a field configuration scheme?
      instructions:
      - text: Rename field configuration scheme {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update field configuration scheme {id} with name {name} and description {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/fieldconfigurationscheme/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field configuration scheme
      effect: destructive
      questions:
      - How do I delete a field configuration scheme?
      - Is it possible to remove a scheme used only by classic projects?
      instructions:
      - text: Delete field configuration scheme {id}.
        slots:
          id: path.id
      - text: Remove the obsolete field configuration scheme {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- 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 than tasks?
      - Can I assign several issue types to field configurations in one scheme call?
      instructions:
      - text: Apply issue type mappings {mappings} to 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-10-01'
- 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 unmap issue types from a field configuration scheme?
      - Can I drop several issue types from a scheme's mappings at once?
      instructions:
      - text: Remove issue types {issueTypeIds} from field configuration scheme {id}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          id: path.id
      - text: Unmap issue types {issueTypeIds} in scheme {id}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          id: path.id
      method: generated
      generated: '2026-10-01'