# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Data Folder Sharings API
  version: 1.0.0
extends: openapi/wistia-folder-sharings-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: 5
- target: $.paths['/folders/{folderId}/sharings'].get
  update:
    x-apievangelist-phrasing:
      intent: List who a folder is shared with
      effect: read
      questions:
      - Who has this folder been shared with?
      - Which contacts and groups can see one of my folders?
      instructions:
      - text: List the sharings on folder {folderId}.
        slots:
          folderId: path.folderId
      - text: Show everyone folder {folderId} is shared with.
        slots:
          folderId: path.folderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{folderId}/sharings'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a folder with someone
      effect: write
      questions:
      - How do I share a folder with a colleague by email?
      - Can I give someone access to a whole folder of videos?
      instructions:
      - text: Share folder {folderId} using {sharing}.
        slots:
          folderId: path.folderId
          sharing: requestBody.sharing
      - text: Give access to folder {folderId} with sharing settings {sharing}.
        slots:
          folderId: path.folderId
          sharing: requestBody.sharing
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{folderId}/sharings/{sharingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show one folder sharing
      effect: read
      questions:
      - What permissions does a specific folder sharing grant?
      - How do I look at the details of one person's access to a folder?
      instructions:
      - text: Show sharing {sharingId} on folder {folderId}.
        slots:
          sharingId: path.sharingId
          folderId: path.folderId
      - text: Get the permissions of sharing {sharingId} for folder {folderId}.
        slots:
          sharingId: path.sharingId
          folderId: path.folderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{folderId}/sharings/{sharingId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a folder sharing
      effect: write
      questions:
      - How do I change what someone can do in a folder I shared?
      - Can I update an existing folder share's permissions?
      instructions:
      - text: Update sharing {sharingId} on folder {folderId} to {sharing}.
        slots:
          sharingId: path.sharingId
          folderId: path.folderId
          sharing: requestBody.sharing
      - text: Change the permissions on folder {folderId} share {sharingId}.
        slots:
          folderId: path.folderId
          sharingId: path.sharingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{folderId}/sharings/{sharingId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop sharing a folder with someone
      effect: destructive
      questions:
      - How do I remove someone's access to a shared folder?
      - Can I unshare a folder from one contact?
      instructions:
      - text: Delete sharing {sharingId} from folder {folderId}.
        slots:
          sharingId: path.sharingId
          folderId: path.folderId
      - text: Unshare folder {folderId} for sharing {sharingId}.
        slots:
          folderId: path.folderId
          sharingId: path.sharingId
      method: generated
      generated: '2026-10-01'