# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Aembit Cloud Role API
  version: 1.0.0
extends: openapi/aembit-role-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: 6
- target: $.paths['/api/v1/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles
      effect: read
      questions:
      - Which roles are defined for admin users?
      - Can I filter the list of roles?
      instructions:
      - text: List my roles.
      - text: List roles matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/roles'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a role's permissions
      effect: write
      questions:
      - How do I change the permissions granted by a role?
      - Can I change which resource sets a role covers?
      instructions:
      - text: Update role {name} with permissions {permissions}.
        slots:
          name: requestBody.name
          permissions: requestBody.permissions
      - text: Replace role {name} so it covers resource sets {resourceSets}.
        slots:
          name: requestBody.name
          resourceSets: requestBody.resourceSets
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a role
      effect: write
      questions:
      - How do I create a custom role for administrators?
      - Can I scope a new role to certain resource sets?
      instructions:
      - text: Create role {name} with permissions {permissions}.
        slots:
          name: requestBody.name
          permissions: requestBody.permissions
      - text: Create a new role {name} scoped to resource sets {resourceSets}.
        slots:
          name: requestBody.name
          resourceSets: requestBody.resourceSets
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/roles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a role
      effect: read
      questions:
      - What permissions does a specific role grant?
      - How many users are assigned to one role?
      instructions:
      - text: Show role {id}.
        slots:
          id: path.id
      - text: Get the permissions of role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/roles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a role
      effect: destructive
      questions:
      - Can I delete a custom role?
      - What is the call to remove a role by ID?
      instructions:
      - text: Delete role {id}.
        slots:
          id: path.id
      - text: Remove the role with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/roles/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or toggle a role
      effect: write
      questions:
      - Can I deactivate a role without deleting it?
      - Is it possible to rename a role?
      instructions:
      - text: Deactivate role {id}.
        slots:
          id: path.id
      - text: Rename role {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'