# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Showpad Userpermissions API
  version: 1.0.0
extends: openapi/showpad-user-permissions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/userpermissions.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List user permission profiles
      effect: read
      questions:
      - Which user permission profiles allow web access or kiosk mode?
      - Can I find permission profiles that let users export contacts?
      instructions:
      - text: List all user permission profiles.
      - text: Show user permission profiles where crm is {crm}.
        slots:
          crm: query.crm
      method: generated
      generated: '2026-10-02'
- target: $.paths['/userpermissions.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user permission profile
      effect: write
      questions:
      - How do I define a new set of user permissions for a role?
      - Which feature flags must be set when creating a user permission profile?
      instructions:
      - text: Create user permission profile {name} with web access {webAccess} and smartphone access {smartPhoneAccess}.
        slots:
          name: requestBody.name
          webAccess: requestBody.webAccess
          smartPhoneAccess: requestBody.smartPhoneAccess
      - text: Add permission profile {name} with contact export {contactExport} and Salesforce integration {salesforceIntegration}.
        slots:
          name: requestBody.name
          contactExport: requestBody.contactExport
          salesforceIntegration: requestBody.salesforceIntegration
      method: generated
      generated: '2026-10-02'
- target: $.paths['/userpermissions/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count user permission profiles
      effect: read
      questions:
      - How many user permission profiles exist?
      - What number of permission profiles enable sales engagement?
      instructions:
      - text: Count user permission profiles.
      - text: Count permission profiles with salesEngagement {salesEngagement}.
        slots:
          salesEngagement: query.salesEngagement
      method: generated
      generated: '2026-10-02'
- target: $.paths['/userpermissions/description.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe the UserPermission model
      effect: read
      questions:
      - What feature switches make up the UserPermission model?
      - Which user permission endpoints does the model description list?
      instructions:
      - text: Show the UserPermission model description.
      - text: Fetch the user permission schema and available APIs.
      method: generated
      generated: '2026-10-02'
- target: $.paths['/userpermissions/{id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a user permission profile
      effect: read
      questions:
      - How do I look up one user permission profile by its ID?
      - What features does a specific permission profile switch on?
      instructions:
      - text: Get user permission profile {id}.
        slots:
          id: path.id
      - text: Show user permission {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-10-02'
- target: $.paths['/userpermissions/{id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user permission profile with PUT
      effect: write
      questions:
      - How do I turn off web access in a permission profile using PUT?
      - Can I rename a user permission profile with a PUT request?
      instructions:
      - text: PUT webAccess {webAccess} on user permission profile {id}.
        slots:
          webAccess: requestBody.webAccess
          id: path.id
      - text: Using PUT, rename user permission {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-02'
- target: $.paths['/userpermissions/{id}.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a user permission profile with POST
      effect: write
      questions:
      - Is there a POST alternative for editing a user permission profile?
      - Can I enable file commenting in a permission profile via POST?
      instructions:
      - text: Via the POST update call, set fileCommenting to {fileCommenting} on user permission {id}.
        slots:
          fileCommenting: requestBody.fileCommenting
          id: path.id
      - text: POST a change of tagSearch to {tagSearch} for permission profile {id}.
        slots:
          tagSearch: requestBody.tagSearch
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/userpermissions/{id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user permission profile
      effect: destructive
      questions:
      - How do I remove a user permission profile we no longer use?
      - What deletes a user permission record by ID?
      instructions:
      - text: Delete user permission profile {id}.
        slots:
          id: path.id
      - text: Remove user permission record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/userpermissions/{id}/link.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a resource to a user permission profile
      effect: write
      questions:
      - How do I attach a related resource to a user permission profile with a Link reference?
      - Is there a link call on user permission records?
      instructions:
      - text: Link user permission {id} to {Link}.
        slots:
          id: path.id
          Link: requestBody.Link
      - text: Attach {Link} to user permission profile {id}.
        slots:
          Link: requestBody.Link
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/userpermissions/{id}/unlink.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlink a resource from a user permission profile
      effect: destructive
      questions:
      - How do I detach a linked resource from a user permission profile?
      - Can I remove a Link association without deleting the permission profile?
      instructions:
      - text: Unlink {Link} from user permission {id}.
        slots:
          Link: requestBody.Link
          id: path.id
      - text: Detach linked resource {Link} from user permission profile {id}.
        slots:
          Link: requestBody.Link
          id: path.id
      method: generated
      generated: '2026-10-02'