Talon.One · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Management Roles API

4 actions 4 updates phrasing extends openapi/talon-one-roles-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Talon.One's API. It is a proposal applied on top of the contract, not a document Talon.One publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v2/roles'].get
$.paths['/v2/roles/{roleId}'].get
$.paths['/v2/roles/{roleId}'].put

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Management Roles API
  version: 1.0.0
extends: openapi/talon-one-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: 3
- target: $.paths['/v2/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List user roles
      effect: read
      questions:
      - What roles exist in my Talon.One account?
      - Where can I find a role's ID to assign it to users?
      instructions:
      - text: List all roles in my account.
      - text: Show every role and its ID.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/roles/{roleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a role's permissions and members
      effect: read
      questions:
      - Which permissions and users does a particular role have?
      - Can I look up one role's details by ID?
      instructions:
      - text: Get role {roleId}.
        slots:
          roleId: path.roleId
      - text: Show the permissions and members of role {roleId}.
        slots:
          roleId: path.roleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/roles/{roleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a role
      effect: write
      questions:
      - How do I add a colleague to an existing role?
      - Can I change a role's permissions or rename it?
      instructions:
      - text: Assign users {members} to role {roleId}.
        slots:
          members: requestBody.members
          roleId: path.roleId
      - text: Rename role {roleId} to {name}.
        slots:
          roleId: path.roleId
          name: requestBody.name
      - text: Update role {roleId}'s permissions to {permissions}.
        slots:
          roleId: path.roleId
          permissions: requestBody.permissions
      method: generated
      generated: '2026-09-26'