Wistia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Project Sharings API

6 actions 6 updates phrasing extends openapi/wistia-project-sharings-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Wistia's API. It is a proposal applied on top of the contract, not a document Wistia publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/projects/{projectId}/sharings'].get
$.paths['/projects/{projectId}/sharings'].post
$.paths['/projects/{projectId}/sharings/{sharingId}'].get
$.paths['/projects/{projectId}/sharings/{sharingId}'].put
$.paths['/projects/{projectId}/sharings/{sharingId}'].delete

OpenAPI Overlay

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