API Evangelist conversational phrasing for Atlassian The 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 Atlassian The Jira Cloud platform REST Filter Sharing API
  version: 1.0.0
extends: openapi/atlassian-filter-sharing-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: 6
- target: $.paths['/rest/api/3/filter/defaultShareScope'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my default share scope for filters
      effect: read
      questions:
      - Are my new Jira filters and dashboards private or shared by default?
      - What's my current default sharing setting for new filters?
      instructions:
      - text: Show my default share scope for new filters and dashboards.
      - text: Check whether my new filters default to private or global sharing.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/filter/defaultShareScope'].put
  update:
    x-apievangelist-phrasing:
      intent: Set my default share scope for filters
      effect: write
      questions:
      - How do I make new filters private by default?
      - Can I change the default sharing for dashboards I create?
      instructions:
      - text: Set my default share scope for new filters and dashboards to {scope}.
        slots:
          scope: requestBody.scope
      - text: Make new filters I create default to {scope} sharing.
        slots:
          scope: requestBody.scope
      method: generated
      generated: '2026-10-01'
- 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 Jira filter shared with?
      - Is this filter shared with the public or all logged-in users?
      instructions:
      - text: List the share permissions on filter {id}.
        slots:
          id: path.id
      - text: Show every group, project and user filter {id} is shared with.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/filter/{id}/permission'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a filter with a group, project or user
      effect: write
      questions:
      - How do I share a saved filter with a group or project?
      - What happens to existing shares if I share a filter globally?
      instructions:
      - text: Share filter {id} with group {groupId}.
        slots:
          id: path.id
          groupId: requestBody.groupId
      - text: Add a {type} share permission to filter {id} for project {projectId}.
        slots:
          type: requestBody.type
          id: path.id
          projectId: requestBody.projectId
      method: generated
      generated: '2026-10-01'
- 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:
      - Can I look up a single share entry on a filter by its ID?
      - What does a specific filter share permission grant?
      instructions:
      - text: Get share permission {permissionId} on filter {id}.
        slots:
          permissionId: path.permissionId
          id: path.id
      - text: Show who share entry {permissionId} on filter {id} applies to.
        slots:
          permissionId: path.permissionId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/filter/{id}/permission/{permissionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unshare a filter
      effect: destructive
      questions:
      - How do I stop sharing a filter with a group?
      - Who is allowed to remove a share permission from a filter?
      instructions:
      - text: Delete share permission {permissionId} from filter {id}.
        slots:
          permissionId: path.permissionId
          id: path.id
      - text: Revoke share entry {permissionId} on filter {id}.
        slots:
          permissionId: path.permissionId
          id: path.id
      method: generated
      generated: '2026-10-01'