API Evangelist conversational phrasing for Jira Cloud platform REST Field schemes 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 Field schemes API
  version: 1.0.0
extends: openapi/jira-field-schemes-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/config/fieldschemes'].get
  update:
    x-apievangelist-phrasing:
      intent: List field schemes
      effect: read
      questions:
      - What field schemes are set up on my Jira site?
      - Can I filter field schemes by project or by a text search on the name?
      instructions:
      - text: List all field association schemes.
      - text: Find field schemes used by project {projectId} matching {query}.
        slots:
          projectId: query.projectId
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/config/fieldschemes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new field scheme
      effect: write
      questions:
      - How do I create a brand new field scheme from scratch?
      - Does a newly created field scheme start with only a minimal set of default fields?
      instructions:
      - text: Create a field scheme named {name}.
        slots:
          name: requestBody.name
      - text: Create field scheme {name} with description {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/config/fieldschemes/fields'].put
  update:
    x-apievangelist-phrasing:
      intent: Update which fields belong to field schemes
      effect: write
      questions:
      - Can I add fields to several field schemes in one go?
      - Is there a bulk way to change the field membership of field schemes?
      instructions:
      - text: Associate the listed fields with their field schemes.
      - text: Bulk update field memberships across my field association schemes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/config/fieldschemes/fields'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove fields from field schemes
      effect: destructive
      questions:
      - How can I take fields out of one or more field schemes?
      - Can I detach a field from multiple field association schemes at once?
      instructions:
      - text: Remove the specified fields from their field schemes.
      - text: Detach these fields from every field association scheme listed.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/config/fieldschemes/fields/parameters'].put
  update:
    x-apievangelist-phrasing:
      intent: Update field parameters in field schemes
      effect: write
      questions:
      - Can I override a field's parameters, like required or description, per work type in a field scheme?
      - Which call changes field item parameters inside field association schemes?
      instructions:
      - text: Update the field parameter overrides in my field schemes.
      - text: Set new work-type parameter values for fields in field association schemes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/config/fieldschemes/fields/parameters'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove field parameter overrides
      effect: destructive
      questions:
      - How do I clear work type overrides on field parameters in a field scheme?
      - Can I reset a field's parameters back to the scheme default for certain work types?
      instructions:
      - text: Remove the field parameter overrides for the given work types.
      - text: Clear work-type specific parameter overrides from field schemes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/config/fieldschemes/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: Get field schemes assigned to projects
      effect: read
      questions:
      - Which field scheme is each of my projects using?
      - Can I check field scheme assignments while migrating off legacy field configurations?
      instructions:
      - text: Show the field schemes for projects {projectId}.
        slots:
          projectId: query.projectId
      - text: Look up which field association scheme project {projectId} is on.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/config/fieldschemes/projects'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign projects to field schemes
      effect: write
      questions:
      - How do I switch a project to a different field scheme?
      - Can I associate several projects with field schemes in one request?
      instructions:
      - text: Associate the listed projects with their field schemes.
      - text: Move these projects onto the specified field association schemes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/config/fieldschemes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a field scheme by ID
      effect: read
      questions:
      - What are the name and description of a specific field scheme?
      - Can I fetch a single field association scheme by its ID?
      instructions:
      - text: Get field scheme {id}.
        slots:
          id: path.id
      - text: Show me the details of field association scheme {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/config/fieldschemes/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a field scheme
      effect: write
      questions:
      - Can I rename an existing field scheme?
      - How would I change the description on a field scheme?
      instructions:
      - text: Rename field scheme {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update the description of field scheme {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/config/fieldschemes/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field scheme
      effect: destructive
      questions:
      - How do I delete a field scheme I no longer use?
      - Can a field association scheme be removed permanently?
      instructions:
      - text: Delete field scheme {id}.
        slots:
          id: path.id
      - text: Permanently remove field association scheme {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/config/fieldschemes/{id}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a field scheme
      effect: write
      questions:
      - Can I copy an existing field scheme into a new one?
      - What's the way to duplicate a field scheme under a new name?
      instructions:
      - text: Clone field scheme {id} as {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Make a copy of field association scheme {id} named {name} with description {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/config/fieldschemes/{id}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: Search fields in a field scheme
      effect: read
      questions:
      - Which fields belong to a particular field scheme?
      - Can I check whether a specific field is part of a field scheme?
      instructions:
      - text: List the fields in field scheme {id}.
        slots:
          id: path.id
      - text: Check if field {fieldId} is in field scheme {id}.
        slots:
          fieldId: query.fieldId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/config/fieldschemes/{id}/fields/{fieldId}/parameters'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a field's parameters in a field scheme
      effect: read
      questions:
      - What parameter overrides does a field have inside a given field scheme?
      - Is a field marked required for certain work types in a field scheme?
      instructions:
      - text: Get the parameters of field {fieldId} in field scheme {id}.
        slots:
          fieldId: path.fieldId
          id: path.id
      - text: Show work-type overrides for field {fieldId} on scheme {id}.
        slots:
          fieldId: path.fieldId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/config/fieldschemes/{id}/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: Search projects using a field scheme
      effect: read
      questions:
      - Which projects are using a given field scheme?
      - Can I check whether one project belongs to a field scheme?
      instructions:
      - text: List the projects on field scheme {id}.
        slots:
          id: path.id
      - text: Check if project {projectId} is associated with field scheme {id}.
        slots:
          projectId: query.projectId
          id: path.id
      method: generated
      generated: '2026-09-26'