Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Test Observer Users API

6 actions 6 updates phrasing extends openapi/canonical-users-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v1/users/me'].get

$.paths['/v1/users'].get

$.paths['/v1/users/{user_id}'].get

$.paths['/v1/users/{user_id}'].delete

$.paths['/v1/users/{user_id}'].patch

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 Test Observer Users API
  version: 1.0.0
extends: openapi/canonical-users-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['/v1/users/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my own user profile
      effect: read
      questions:
      - Which Test Observer user am I signed in as?
      - Do I have admin rights on my current account?
      instructions:
      - text: Show my own user profile.
      - text: Tell me who I'm authenticated as.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List or search users
      effect: read
      questions:
      - Who are the users registered in Test Observer?
      - Can I search users by a name or email query?
      instructions:
      - text: List all users.
      - text: Search users matching {q}, {limit} per page.
        slots:
          q: query.q
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/users/{user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user
      effect: read
      questions:
      - What are the details of a specific Test Observer user?
      - Can I look up one user by ID?
      instructions:
      - text: Show user {user_id}.
        slots:
          user_id: path.user_id
      - text: Get the profile of user {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/users/{user_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user
      effect: destructive
      questions:
      - How do I remove a user from Test Observer?
      - Is deleting a user account permanent?
      instructions:
      - text: Delete user {user_id}.
        slots:
          user_id: path.user_id
      - text: Remove the account of user {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/users/{user_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Grant or revoke admin for a user
      effect: write
      questions:
      - How do I make a user an admin?
      - Can I take admin rights away from someone?
      instructions:
      - text: Set admin status of user {user_id} to {is_admin}.
        slots:
          user_id: path.user_id
          is_admin: requestBody.is_admin
      - text: Make user {user_id} an admin.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'