# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Workfront Planning API Version 2 Permissions API
  version: 1.0.0
extends: openapi/workfront-permissions-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: 7
- target: $.paths['/v2/permissions/{resourceType}/{resourceId}/requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List pending access requests on a resource
      effect: read
      questions:
      - Who is waiting for me to approve access to my workspace?
      - Can I see pending access requests on a record or view I manage?
      instructions:
      - text: List pending access requests on {resourceType} {resourceId}.
        slots:
          resourceType: path.resourceType
          resourceId: path.resourceId
      - text: Show who has asked for access to workspace {resourceId}.
        slots:
          resourceId: path.resourceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/permissions/{resourceType}/{resourceId}/requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Request access to a resource
      effect: write
      questions:
      - How do I ask for access to a workspace I can't open?
      - Can I add a note explaining why I need access when requesting it?
      instructions:
      - text: Request access to {resourceType} {resourceId} for me.
        slots:
          resourceType: path.resourceType
          resourceId: path.resourceId
      - text: Ask for access to {resourceType} {resourceId} with the message {message}.
        slots:
          resourceType: path.resourceType
          resourceId: path.resourceId
          message: requestBody.message
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/permissions/{resourceType}/{resourceId}/requests'].delete
  update:
    x-apievangelist-phrasing:
      intent: Dismiss access requests on a resource
      effect: destructive
      questions:
      - How do I dismiss access requests I don't want to approve?
      - What permission do I need to clear out someone's request for access?
      instructions:
      - text: Dismiss access requests {requestIds} on {resourceType} {resourceId}.
        slots:
          requestIds: requestBody.requestIds
          resourceType: path.resourceType
          resourceId: path.resourceId
      - text: Decline and clear request {requestIds} for {resourceType} {resourceId}.
        slots:
          requestIds: requestBody.requestIds
          resourceType: path.resourceType
          resourceId: path.resourceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/permissions/{resourceType}/{resourceId}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List who a resource is shared with and their roles
      effect: read
      questions:
      - Which users, groups and teams have been given access to this record type?
      - What role does each member have on a shared workspace?
      instructions:
      - text: List the members and roles on {resourceType} {resourceId}.
        slots:
          resourceType: path.resourceType
          resourceId: path.resourceId
      - text: Show everyone explicitly shared on view {resourceId}.
        slots:
          resourceId: path.resourceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/permissions/{resourceType}/{resourceId}/members'].patch
  update:
    x-apievangelist-phrasing:
      intent: Grant, change or revoke members' access
      effect: destructive
      questions:
      - Can I add new people, change roles and remove others from a workspace in one request?
      - How do I make a record type view-only for workspace members instead of inherited?
      - Can I turn on wildcard access for a single record?
      instructions:
      - text: Grant {grant} access to {resourceType} {resourceId}.
        slots:
          grant: requestBody.grant
          resourceType: path.resourceType
          resourceId: path.resourceId
      - text: Revoke all access for {revoke} on {resourceType} {resourceId}.
        slots:
          revoke: requestBody.revoke
          resourceType: path.resourceType
          resourceId: path.resourceId
      - text: Change roles for {update} on {resourceType} {resourceId}.
        slots:
          update: requestBody.update
          resourceType: path.resourceType
          resourceId: path.resourceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/permissions/{resourceType}/{resourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my effective permissions on a resource
      effect: read
      questions:
      - Am I allowed to edit or delete this record?
      - 'What can I do on a given workspace: view, edit, delete or add?'
      instructions:
      - text: Check my permissions on {resourceType} {resourceId}.
        slots:
          resourceType: path.resourceType
          resourceId: path.resourceId
      - text: Tell me whether I can edit record {resourceId}.
        slots:
          resourceId: path.resourceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/permissions/{resourceType}/{resourceId}/inheritance'].get
  update:
    x-apievangelist-phrasing:
      intent: See if a record type inherits workspace access
      effect: read
      questions:
      - Do workspace members automatically get their workspace access on this record type?
      - Is a record type set to inherited or view-only access for workspace members?
      instructions:
      - text: Check the inheritance setting on {resourceType} {resourceId}.
        slots:
          resourceType: path.resourceType
          resourceId: path.resourceId
      - text: Tell me whether record type {resourceId} inherits workspace permissions.
        slots:
          resourceId: path.resourceId
      method: generated
      generated: '2026-10-01'