OpenMercantil · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenMercantil API Credentials API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api/v1/user/api-credentials'].get
$.paths['/api/v1/user/api-credentials'].post
$.paths['/api/v1/user/api-credentials/{id}/rotate'].post
$.paths['/api/v1/user/api-credentials/{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 OpenMercantil API Credentials API
  version: 1.0.0
extends: openapi/openmercantil-api-credentials-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: 4
- target: $.paths['/api/v1/user/api-credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List my API credentials
      effect: read
      questions:
      - Which API keys does my OpenMercantil account have and what scopes do they carry?
      - Can I see a credential's prefix and last four characters without exposing the token?
      instructions:
      - text: List my API credentials.
      - text: Show {limit} API credentials starting from cursor {cursor}.
        slots:
          limit: query.limit
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/user/api-credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API credential
      effect: write
      questions:
      - How do I generate a new API key for my account?
      - How long can a new API credential stay valid before it expires?
      - Is the full token shown again after I create a credential?
      instructions:
      - text: Create an API credential named {name} with scopes {scopes}.
        slots:
          name: requestBody.name
          scopes: requestBody.scopes
      - text: Issue a new API key with scopes {scopes} that expires on {expires_at}.
        slots:
          scopes: requestBody.scopes
          expires_at: requestBody.expires_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/user/api-credentials/{id}/rotate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an API credential
      effect: destructive
      questions:
      - How do I replace a leaked API key with a fresh token?
      - Does rotating a credential revoke the old token immediately?
      instructions:
      - text: Rotate API credential {id}.
        slots:
          id: path.id
      - text: Rotate credential {id} and give the replacement scopes {scopes}.
        slots:
          id: path.id
          scopes: requestBody.scopes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/user/api-credentials/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an API credential
      effect: destructive
      questions:
      - How do I permanently disable one of my API keys?
      - Can I revoke an API credential without issuing a replacement?
      instructions:
      - text: Revoke API credential {id}.
        slots:
          id: path.id
      - text: Kill the API key {id} so it stops working.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'