Emboss · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Getemboss Ai Keys API

5 actions 5 updates phrasing extends openapi/getemboss-ai-keys-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Emboss's API. It is a proposal applied on top of the contract, not a document Emboss publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/keys'].get
$.paths['/keys'].post
$.paths['/keys/{key_id}'].delete
$.paths['/keys/{key_id}'].patch

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 Getemboss Ai Keys API
  version: 1.0.0
extends: openapi/getemboss-ai-keys-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: 4
- target: $.paths['/keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List an owner's API keys
      effect: read
      questions:
      - Which API keys exist on my account?
      - Can I see the labels of all keys for an owner?
      instructions:
      - text: List the API keys for owner {owner}.
        slots:
          owner: query.owner
      - text: Show every key {owner} has issued.
        slots:
          owner: query.owner
      method: generated
      generated: '2026-10-01'
- target: $.paths['/keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new API key
      effect: write
      questions:
      - How do I generate a new API key?
      - Can I give an API key a label when I create it?
      instructions:
      - text: Create an API key for owner {owner}.
        slots:
          owner: requestBody.owner
      - text: Issue a new key labelled {label} for {owner}.
        slots:
          label: requestBody.label
          owner: requestBody.owner
      method: generated
      generated: '2026-10-01'
- target: $.paths['/keys/{key_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API key
      effect: destructive
      questions:
      - How do I permanently delete an API key I no longer need?
      - What happens to calls using a key after it's deleted?
      instructions:
      - text: Delete API key {key_id} for owner {owner}.
        slots:
          key_id: path.key_id
          owner: query.owner
      - text: Remove {owner}'s key {key_id}.
        slots:
          owner: query.owner
          key_id: path.key_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/keys/{key_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or change the state of an API key
      effect: write
      questions:
      - Can I rename an existing API key?
      - Can I apply an action like disabling to a key without deleting it?
      instructions:
      - text: Rename key {key_id} for {owner} to {label}.
        slots:
          key_id: path.key_id
          owner: query.owner
          label: requestBody.label
      - text: Apply action {action} to {owner}'s key {key_id}.
        slots:
          action: requestBody.action
          owner: query.owner
          key_id: path.key_id
      method: generated
      generated: '2026-10-01'