BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Users API

3 actions 3 updates phrasing extends openapi/blueconic-users-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for BlueConic's API. It is a proposal applied on top of the contract, not a document BlueConic publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/users'].get

$.paths['/users/{user}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BlueConic REST API v2 Users API
  version: 1.0.0
extends: openapi/blueconic-users-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: 2
- target: $.paths['/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List all BlueConic users
      effect: read
      questions:
      - Who has a user account in our BlueConic tenant?
      - Can I page through the user list?
      instructions:
      - text: List all users.
      - text: Show {count} users starting at index {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single user
      effect: read
      questions:
      - What roles and details does one specific user have?
      - Can I retrieve a user by ID?
      instructions:
      - text: Get user {user}.
        slots:
          user: path.user
      - text: Show the account details of user {user}.
        slots:
          user: path.user
      method: generated
      generated: '2026-10-01'