# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Showpad Divisionpermissions API
  version: 1.0.0
extends: openapi/showpad-divisionpermissions-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: 10
- target: $.paths['/divisionpermissions.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List division permissions
      effect: read
      questions:
      - Which division permissions exist across the account?
      - Can I find division permissions that allow managing content or reporting?
      instructions:
      - text: List all division permissions.
      - text: Show division permissions where manageContent is {manageContent}.
        slots:
          manageContent: query.manageContent
      method: generated
      generated: '2026-10-01'
- target: $.paths['/divisionpermissions.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a division permission
      effect: write
      questions:
      - How do I grant someone administrative rights over a division?
      - Can a new division permission have an expiry date?
      instructions:
      - text: Create a division permission for user {userId} in division {divisionId}.
        slots:
          userId: requestBody.userId
          divisionId: requestBody.divisionId
      - text: Give user {userId} user-management rights {manageUsers} in division {divisionId}.
        slots:
          userId: requestBody.userId
          manageUsers: requestBody.manageUsers
          divisionId: requestBody.divisionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/divisionpermissions/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count division permissions
      effect: read
      questions:
      - How many division permissions grant asset management?
      - What is the total number of division permission records?
      instructions:
      - text: Count division permissions with manageAssets {manageAssets}.
        slots:
          manageAssets: query.manageAssets
      - text: Count all division permissions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/divisionpermissions/description.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe the DivisionPermission model
      effect: read
      questions:
      - What flags does a DivisionPermission record have?
      - Which division permission endpoints are listed in the model description?
      instructions:
      - text: Show the DivisionPermission model description.
      - text: Fetch the division permission schema and available APIs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/divisionpermissions/{id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a division permission
      effect: read
      questions:
      - How do I look up one division permission by its ID?
      - What rights does a specific division permission grant?
      instructions:
      - text: Get division permission {id}.
        slots:
          id: path.id
      - text: Show the details of division permission {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/divisionpermissions/{id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a division permission with PUT
      effect: write
      questions:
      - How do I change what a division permission allows using PUT?
      - Can I extend a division permission's expiry with a PUT update?
      instructions:
      - text: PUT an expiry of {expiredAt} on division permission {id}.
        slots:
          expiredAt: requestBody.expiredAt
          id: path.id
      - text: Using PUT, set manageAssets to {manageAssets} on division permission {id}.
        slots:
          manageAssets: requestBody.manageAssets
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/divisionpermissions/{id}.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a division permission with POST
      effect: write
      questions:
      - Is there a POST alternative for editing a division permission?
      - Can I toggle reporting access on a division permission via POST?
      instructions:
      - text: Via the POST update call, set contentReporting to {contentReporting} on division permission {id}.
        slots:
          contentReporting: requestBody.contentReporting
          id: path.id
      - text: POST a change of viewUsers to {viewUsers} for division permission {id}.
        slots:
          viewUsers: requestBody.viewUsers
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/divisionpermissions/{id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a division permission
      effect: destructive
      questions:
      - How do I revoke a division permission entirely?
      - What removes a division permission record by ID?
      instructions:
      - text: Delete division permission {id}.
        slots:
          id: path.id
      - text: Revoke and remove division permission record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/divisionpermissions/{id}/link.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a resource to a division permission
      effect: write
      questions:
      - How do I attach a related resource to a division permission with a Link reference?
      - Is there a link call on division permission records?
      instructions:
      - text: Link division permission {id} to {Link}.
        slots:
          id: path.id
          Link: requestBody.Link
      - text: Attach {Link} to division permission record {id}.
        slots:
          Link: requestBody.Link
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/divisionpermissions/{id}/unlink.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlink a resource from a division permission
      effect: destructive
      questions:
      - How do I detach a linked resource from a division permission?
      - Can I remove a Link association without deleting the division permission?
      instructions:
      - text: Unlink {Link} from division permission {id}.
        slots:
          Link: requestBody.Link
          id: path.id
      - text: Detach linked resource {Link} from division permission record {id}.
        slots:
          Link: requestBody.Link
          id: path.id
      method: generated
      generated: '2026-10-01'