Xquik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Xquik API Keys API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/api/v1/api-keys'].get
$.paths['/api/v1/api-keys'].post
$.paths['/api/v1/api-keys/{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 Xquik API Keys API
  version: 1.0.0
extends: openapi/xquik-api-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['/api/v1/api-keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List my API keys
      effect: read
      questions:
      - Which API keys exist on my account?
      - Can I see all the API keys I've created?
      instructions:
      - text: List my API keys.
      - text: Show every API key on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/api-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 a new API key a name so I remember what it's for?
      instructions:
      - text: Create a new API key named {name}.
        slots:
          name: requestBody.name
      - text: Generate a fresh API key for me.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/api-keys/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an API key
      effect: destructive
      questions:
      - Can I revoke an API key that leaked?
      - What's the way to permanently disable an old API key?
      instructions:
      - text: Revoke API key {id}.
        slots:
          id: path.id
      - text: Kill the leaked API key {id} now.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'