API Evangelist conversational phrasing for Jira Cloud platform REST Filter sharing 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 Filter sharing API
  version: 1.0.0
extends: openapi/jira-filter-sharing-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: 6
- target: $.paths['/rest/api/3/filter/defaultShareScope'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my default sharing for new filters
      effect: read
      questions:
      - Who are my new filters and dashboards shared with by default?
      - Are my new saved filters private or shared automatically?
      instructions:
      - text: Show my default share scope for new filters and dashboards.
      - text: Check whether my new filters default to private or shared.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/defaultShareScope'].put
  update:
    x-apievangelist-phrasing:
      intent: Set default sharing for new filters
      effect: write
      questions:
      - How do I make my new filters and dashboards private by default?
      - Can I have new filters shared with all logged-in users automatically?
      instructions:
      - text: Set my default share scope for new filters to {scope}.
        slots:
          scope: requestBody.scope
      - text: Make new filters and dashboards I create default to {scope} sharing.
        slots:
          scope: requestBody.scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/{id}/permission'].get
  update:
    x-apievangelist-phrasing:
      intent: List a filter's share permissions
      effect: read
      questions:
      - Who is a saved filter shared with?
      - Is my filter shared publicly or with specific groups and projects?
      instructions:
      - text: List the share permissions on filter {id}.
        slots:
          id: path.id
      - text: Show everyone filter {id} is shared with.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/{id}/permission'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a filter with a user, group or project
      effect: write
      questions:
      - How do I share a saved filter with a group or project?
      - Will sharing a filter with everyone wipe out its other share permissions?
      - Can I give another user edit rights on my filter?
      instructions:
      - text: Share filter {id} with project {projectId} using type {type}.
        slots:
          id: path.id
          projectId: requestBody.projectId
          type: requestBody.type
      - text: Share filter {id} with user {accountId} as a {type} permission.
        slots:
          id: path.id
          accountId: requestBody.accountId
          type: requestBody.type
      - text: Add a {type} share permission on filter {id} for group {groupId}.
        slots:
          type: requestBody.type
          id: path.id
          groupId: requestBody.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/{id}/permission/{permissionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one share permission on a filter
      effect: read
      questions:
      - What does one particular share permission on a filter grant?
      - Can I look up a single filter share permission by its ID?
      instructions:
      - text: Get share permission {permissionId} on filter {id}.
        slots:
          permissionId: path.permissionId
          id: path.id
      - text: Show the details of permission {permissionId} for filter {id}.
        slots:
          permissionId: path.permissionId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/filter/{id}/permission/{permissionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop sharing a filter with someone
      effect: destructive
      questions:
      - How do I unshare a filter from a group or project?
      - Do I need to own the filter to remove a share permission?
      instructions:
      - text: Delete share permission {permissionId} from filter {id}.
        slots:
          permissionId: path.permissionId
          id: path.id
      - text: Stop sharing filter {id} via permission {permissionId}.
        slots:
          id: path.id
          permissionId: path.permissionId
      method: generated
      generated: '2026-09-26'