# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Close Roles API
  version: 1.0.0
extends: openapi/close-roles-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/role/'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles
      effect: read
      questions:
      - What permission roles exist in my organization?
      - Can I see every role defined for our users?
      instructions:
      - text: List all roles.
      - text: Show the organization's permission roles.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/role/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom role
      effect: write
      questions:
      - How do I create a role that can only see leads assigned to them?
      - Can a new role see leads that have no assigned user?
      instructions:
      - text: Create a new role for sales reps.
      - text: Add a custom role that limits lead visibility to assigned leads.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/role/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a role
      effect: read
      questions:
      - Which permissions does a specific role have?
      - Can I retrieve one role by id?
      instructions:
      - text: Fetch role {id}.
        slots:
          id: path.id
      - text: Show the permissions on role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/role/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a role
      effect: write
      questions:
      - Can I change the permissions on an existing role?
      - Is it possible to rename a role?
      instructions:
      - text: Update role {id}.
        slots:
          id: path.id
      - text: Change the permissions of role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/role/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom role
      effect: destructive
      questions:
      - Can I delete a role that users are still assigned to?
      - Which call removes a custom role?
      instructions:
      - text: Delete role {id}.
        slots:
          id: path.id
      - text: Remove the custom role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'