Synadia Communications · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NATS HTTP Gateway Extended KV Entry Operations API

5 actions 5 updates phrasing extends openapi/synadia-communications-extended-kv-entry-operations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Synadia Communications's API. It is a proposal applied on top of the contract, not a document Synadia Communications publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/kvm/buckets/{bucket}/keys/{key}'].get
$.paths['/kvm/buckets/{bucket}/keys/{key}'].put
$.paths['/kvm/buckets/{bucket}/keys/{key}'].post
$.paths['/kvm/buckets/{bucket}/keys/{key}'].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 NATS HTTP Gateway Extended KV Entry Operations API
  version: 1.0.0
extends: openapi/synadia-communications-extended-kv-entry-operations-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['/kvm/buckets/{bucket}/keys/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a value from a KV store
      effect: read
      questions:
      - How do I read the value stored under a key in a KV bucket?
      - Can I fetch an older revision of a key's value?
      instructions:
      - text: Get key {key} from KV bucket {bucket}.
        slots:
          bucket: path.bucket
          key: path.key
      - text: Get revision {revision} of key {key} in KV bucket {bucket}.
        slots:
          bucket: path.bucket
          key: path.key
          revision: query.revision
      method: generated
      generated: '2026-10-01'
- target: $.paths['/kvm/buckets/{bucket}/keys/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Put a value into a KV store
      effect: write
      questions:
      - How do I set or overwrite the value of a key in a KV bucket?
      - Can I make a write conditional on the key's previous revision?
      instructions:
      - text: Put a value at key {key} in KV bucket {bucket}.
        slots:
          bucket: path.bucket
          key: path.key
      - text: Update key {key} in KV bucket {bucket} only if its last revision is {previous}.
        slots:
          bucket: path.bucket
          key: path.key
          previous: query.previousRevision
      method: generated
      generated: '2026-10-01'
- target: $.paths['/kvm/buckets/{bucket}/keys/{key}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new KV key only if absent
      effect: write
      questions:
      - Is there a way to add a key to a KV bucket only when it doesn't already exist?
      - What happens if I try to create a KV entry that already exists?
      instructions:
      - text: Create key {key} in KV bucket {bucket}, failing if it exists.
        slots:
          bucket: path.bucket
          key: path.key
      - text: Add new entry {key} to KV bucket {bucket} without overwriting.
        slots:
          bucket: path.bucket
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/kvm/buckets/{bucket}/keys/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a key from a KV store
      effect: destructive
      questions:
      - How do I delete a key from a KV bucket?
      - Can I purge a key's whole history instead of just marking it deleted?
      instructions:
      - text: Delete key {key} from KV bucket {bucket}.
        slots:
          bucket: path.bucket
          key: path.key
      - text: Purge key {key} and its history from KV bucket {bucket} with purge={purge}.
        slots:
          bucket: path.bucket
          key: path.key
          purge: query.purge
      method: generated
      generated: '2026-10-01'