API Evangelist conversational phrasing for Jira Cloud platform REST Filters 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 Filters API
  version: 1.0.0
extends: openapi/jira-filters-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: 13
- target: $.paths['/rest/api/3/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a JQL search as a filter
      effect: write
      questions:
      - How do I save a JQL query as a reusable filter?
      - Can I share a new filter with a group when I create it?
      instructions:
      - text: Create a filter named {name} with JQL {jql}.
        slots:
          name: requestBody.name
          jql: requestBody.jql
      - text: Save filter {name} for {jql} and mark it as a favorite ({favourite}).
        slots:
          name: requestBody.name
          jql: requestBody.jql
          favourite: requestBody.favourite
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/favourite'].get
  update:
    x-apievangelist-phrasing:
      intent: List my favorite filters
      effect: read
      questions:
      - Which filters have I starred as favorites?
      - Can I see my favorite filters along with their share permissions?
      instructions:
      - text: List my favorite filters.
      - text: Show my starred filters with {expand} expanded.
        slots:
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/my'].get
  update:
    x-apievangelist-phrasing:
      intent: List filters I own
      effect: read
      questions:
      - What filters have I created myself?
      - Can I list the filters I own together with my favorites?
      instructions:
      - text: List the filters I own.
      - text: Show my own filters and include favorites ({includeFavourites}).
        slots:
          includeFavourites: query.includeFavourites
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search filters by name, owner or project
      effect: read
      questions:
      - How can I find a filter by part of its name?
      - Can I search for filters owned by a specific person or shared with a project?
      instructions:
      - text: Search for filters whose name contains {filterName}.
        slots:
          filterName: query.filterName
      - text: Find filters owned by account {accountId}, ordered by {orderBy}.
        slots:
          accountId: query.accountId
          orderBy: query.orderBy
      - text: List filters shared with project {projectId}.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a filter
      effect: read
      questions:
      - What JQL is behind a particular saved filter?
      - Can I look up one filter's owner and sharing by its ID?
      instructions:
      - text: Get filter {id}.
        slots:
          id: path.id
      - text: Show the JQL and share settings for filter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a filter's name, JQL or sharing
      effect: write
      questions:
      - How do I change the JQL of a filter I own?
      - Can I update who a saved filter is shared with?
      instructions:
      - text: Change the JQL of filter {id} to {jql}, keeping the name {name}.
        slots:
          id: path.id
          jql: requestBody.jql
          name: requestBody.name
      - text: Rename filter {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a filter
      effect: destructive
      questions:
      - Who is allowed to delete a saved filter?
      - Can I permanently remove a filter I created?
      instructions:
      - text: Delete filter {id}.
        slots:
          id: path.id
      - text: Remove saved filter {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/{id}/columns'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a filter's list view columns
      effect: read
      questions:
      - Which columns show when a filter's results are viewed in list view?
      - Can I read the column configuration of a filter?
      instructions:
      - text: Get the columns configured for filter {id}.
        slots:
          id: path.id
      - text: Show which fields appear as columns for filter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/{id}/columns'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a filter's list view columns
      effect: write
      questions:
      - How do I choose which columns a filter displays?
      - Can any field be a filter column, or only navigable ones?
      instructions:
      - text: Set the columns of filter {id} to {columns}.
        slots:
          id: path.id
          columns: requestBody.columns
      - text: Configure filter {id} to show columns {columns} in list view.
        slots:
          id: path.id
          columns: requestBody.columns
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/{id}/columns'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a filter's columns to default
      effect: destructive
      questions:
      - Can I undo my custom columns on a filter and go back to the default?
      - What resets the column layout of a filter?
      instructions:
      - text: Reset the columns of filter {id} to the default.
        slots:
          id: path.id
      - text: Clear my column configuration for filter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/{id}/favourite'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a filter to my favorites
      effect: write
      questions:
      - How do I star a filter so it shows in my favorites?
      - Can I favorite a filter someone else shared with my group?
      instructions:
      - text: Add filter {id} to my favorites.
        slots:
          id: path.id
      - text: Star filter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/{id}/favourite'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a filter from my favorites
      effect: destructive
      questions:
      - How do I unstar a filter?
      - Can I remove a filter from favorites if it has since been made private?
      instructions:
      - text: Remove filter {id} from my favorites.
        slots:
          id: path.id
      - text: Unstar filter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/{id}/owner'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a filter's owner
      effect: write
      questions:
      - Can I hand ownership of a filter to another user?
      - What do I need to transfer a filter to a colleague who is leaving?
      instructions:
      - text: Make {accountId} the owner of filter {id}.
        slots:
          accountId: requestBody.accountId
          id: path.id
      - text: Transfer filter {id} to user {accountId}.
        slots:
          id: path.id
          accountId: requestBody.accountId
      method: generated
      generated: '2026-09-26'