API Evangelist conversational phrasing for Atlassian The 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 Atlassian The Jira Cloud platform REST Filters API
  version: 1.0.0
extends: openapi/atlassian-filters-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: 13
- target: $.paths['/rest/api/3/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a saved Jira filter
      effect: write
      questions:
      - How do I save a JQL query as a new Jira filter?
      - Who can see a newly created filter by default?
      instructions:
      - text: Create a filter named {name} for the JQL {jql}.
        slots:
          name: requestBody.name
          jql: requestBody.jql
      - text: Save a new filter {name} with description {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/filter/favourite'].get
  update:
    x-apievangelist-phrasing:
      intent: List my favorite filters
      effect: read
      questions:
      - Which Jira filters have I starred as favorites?
      - Can I see my favorite filters even if someone else owns them?
      instructions:
      - text: List my favorite Jira filters.
      - text: Show my starred filters expanded with {expand}.
        slots:
          expand: query.expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/filter/my'].get
  update:
    x-apievangelist-phrasing:
      intent: List filters I own
      effect: read
      questions:
      - What Jira filters have I created myself?
      - Can I include my favorites in the list of filters I own?
      instructions:
      - text: List the filters I own.
      - text: List the filters I own, including favorites set to {includeFavourites}.
        slots:
          includeFavourites: query.includeFavourites
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/filter/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search filters by name, owner or project
      effect: read
      questions:
      - Can I search Jira filters by a word in their name?
      - Which filters are shared with a given group or project?
      instructions:
      - text: Search filters whose name contains {filterName}.
        slots:
          filterName: query.filterName
      - text: Find filters owned by account {accountId}, sorted by {orderBy}.
        slots:
          accountId: query.accountId
          orderBy: query.orderBy
      - text: Find filters shared with project {projectId}.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/filter/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a saved filter
      effect: read
      questions:
      - What JQL does a particular saved filter run?
      - Can I view a filter that's shared with my group but not owned by me?
      instructions:
      - text: Get filter {id}.
        slots:
          id: path.id
      - text: Show the JQL and sharing for filter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- 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 already saved?
      - Can I change who a filter is shared with after creating it?
      instructions:
      - text: Change the JQL of filter {id} named {name} to {jql}.
        slots:
          id: path.id
          name: requestBody.name
          jql: requestBody.jql
      - text: Update filter {id}, keeping name {name}, to share with {sharePermissions}.
        slots:
          id: path.id
          name: requestBody.name
          sharePermissions: requestBody.sharePermissions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/filter/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved filter
      effect: destructive
      questions:
      - Who is allowed to delete a Jira filter?
      - Can I remove a filter I created that nobody uses anymore?
      instructions:
      - text: Delete filter {id}.
        slots:
          id: path.id
      - text: Permanently remove saved filter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- 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 does a filter show in List View?
      - Can I see the column configuration attached to a saved filter?
      instructions:
      - text: Show the columns configured for filter {id}.
        slots:
          id: path.id
      - text: Get the list view column setup of filter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- 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 the columns a filter displays?
      - Can non-navigable fields be used as filter columns?
      instructions:
      - text: Set the columns of filter {id} to {columns}.
        slots:
          id: path.id
          columns: requestBody.columns
      - text: Configure filter {id} to display columns {columns} in List View.
        slots:
          id: path.id
          columns: requestBody.columns
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/filter/{id}/columns'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a filter's columns to default
      effect: destructive
      questions:
      - How do I undo custom columns on a filter?
      - Can I put a filter's column layout back to the default?
      instructions:
      - text: Reset the columns of filter {id} to the default.
        slots:
          id: path.id
      - text: Clear my custom column setup on filter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/filter/{id}/favourite'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark a filter as a favorite
      effect: write
      questions:
      - Can I star a filter someone shared with me?
      - Which filters am I allowed to add to my favorites?
      instructions:
      - text: Add filter {id} to my favorites.
        slots:
          id: path.id
      - text: Star filter {id} for me.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- 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?
      - Why can't I remove a filter from favorites after it was 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-10-01'
- target: $.paths['/rest/api/3/filter/{id}/owner'].put
  update:
    x-apievangelist-phrasing:
      intent: Change who owns a filter
      effect: write
      questions:
      - Can I hand over ownership of a Jira filter to a colleague?
      - Who can transfer a filter to a new owner?
      instructions:
      - text: Transfer filter {id} to account {accountId}.
        slots:
          id: path.id
          accountId: requestBody.accountId
      - text: Make {accountId} the owner of filter {id}.
        slots:
          accountId: requestBody.accountId
          id: path.id
      method: generated
      generated: '2026-10-01'