Akuity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Akuity Platform API — API Keys API Key Service API

7 actions 7 updates phrasing extends openapi/akuity-api-key-service-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/api/v1/apikeys/{id}'].get

$.paths['/api/v1/apikeys/{id}'].delete

$.paths['/api/v1/apikeys/{id}/regenerate'].post

$.paths['/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/apikeys/{id}'].get

$.paths['/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/apikeys/{id}'].delete

$.paths['/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/apikeys/{id}/regenerate'].post

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 Akuity Platform API — API Keys API Key Service API
  version: 1.0.0
extends: openapi/akuity-api-key-service-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: 6
- target: $.paths['/api/v1/apikeys/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API key's details
      effect: read
      questions:
      - What permissions and expiry does one of my Akuity API keys have?
      - Can I look up an organization API key by its ID?
      instructions:
      - text: Show API key {id}.
        slots:
          id: path.id
      - text: Look up the details of organization key {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apikeys/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API key
      effect: destructive
      questions:
      - How do I revoke an API key that leaked?
      - Can I permanently remove an organization-level API key?
      instructions:
      - text: Delete API key {id}.
        slots:
          id: path.id
      - text: Revoke organization key {id} for good.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apikeys/{id}/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate an API key's secret
      effect: write
      questions:
      - How do I rotate the secret of an existing API key without creating a new key?
      - Can I set a new expiry when regenerating a key's secret?
      instructions:
      - text: Regenerate the secret for API key {id}.
        slots:
          id: path.id
      - text: Rotate key {id}'s secret and make it expire at {expiry}.
        slots:
          id: path.id
          expiry: requestBody.expiry
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/apikeys/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace API key's details
      effect: read
      questions:
      - What does a workspace-scoped API key grant?
      - Where do I look up a key that belongs to one workspace?
      instructions:
      - text: Show workspace API key {id} in workspace {workspace_id} of org {organization_id}.
        slots:
          id: path.id
          workspace_id: path.workspace_id
          organization_id: path.organization_id
      - text: Inspect the key {id} scoped to workspace {workspace_id}, organization {organization_id}.
        slots:
          id: path.id
          workspace_id: path.workspace_id
          organization_id: path.organization_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/apikeys/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workspace API key
      effect: destructive
      questions:
      - How do I revoke an API key issued for a single workspace?
      - Is deleting a workspace key immediate and permanent?
      instructions:
      - text: Delete workspace API key {id} from workspace {workspace_id} in org {organization_id}.
        slots:
          id: path.id
          workspace_id: path.workspace_id
          organization_id: path.organization_id
      - text: Revoke the workspace {workspace_id} key {id} under organization {organization_id}.
        slots:
          workspace_id: path.workspace_id
          id: path.id
          organization_id: path.organization_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/apikeys/{id}/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate a workspace API key's secret
      effect: write
      questions:
      - How do I rotate the secret on a workspace-scoped API key?
      - Can a workspace key get a fresh secret with a new expiration date?
      instructions:
      - text: Regenerate the secret of workspace key {id} in workspace {workspace_id}, org {organization_id}.
        slots:
          id: path.id
          workspace_id: path.workspace_id
          organization_id: path.organization_id
      - text: Rotate workspace {workspace_id} key {id} in {organization_id} with expiry {expiry}.
        slots:
          workspace_id: path.workspace_id
          id: path.id
          organization_id: path.organization_id
          expiry: requestBody.expiry
      method: generated
      generated: '2026-10-01'