Hilt · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hilt So API Keys API

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

What the actions change

x-apievangelist-phrasing

Targets 4

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

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 Hilt So API Keys API
  version: 1.0.0
extends: openapi/hilt-so-api-keys-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['/v1/keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List my API keys
      effect: read
      questions:
      - Which API keys have I created?
      - Can I see my keys without exposing their raw values?
      instructions:
      - text: List all my API keys.
      - text: Show my API keys and their names.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API key
      effect: write
      questions:
      - How do I generate a new API key?
      - Can I make a sandbox-only key with limited permissions?
      instructions:
      - text: Create an API key named {name}.
        slots:
          name: requestBody.name
      - text: Create a sandbox API key called {name} with permissions {permissions}.
        slots:
          name: requestBody.name
          permissions: requestBody.permissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/keys/{key_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an API key
      effect: destructive
      questions:
      - How do I permanently revoke a leaked API key?
      - What happens to requests using a key after I revoke it?
      instructions:
      - text: Revoke API key {key_id}.
        slots:
          key_id: path.key_id
      - text: Kill key {key_id} immediately.
        slots:
          key_id: path.key_id
      method: generated
      generated: '2026-09-26'