Synadia Communications · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NATS HTTP Gateway ObjectStore Entry Operations API

4 actions 4 updates phrasing extends openapi/synadia-communications-objectstore-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 4

$.info
$.paths['/objm/buckets/{bucket}/keys/{key}'].get
$.paths['/objm/buckets/{bucket}/keys/{key}'].put
$.paths['/objm/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 ObjectStore Entry Operations API
  version: 1.0.0
extends: openapi/synadia-communications-objectstore-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: 3
- target: $.paths['/objm/buckets/{bucket}/keys/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an object from an object store
      effect: read
      questions:
      - How do I download a file stored in an object store?
      - Can I retrieve one object by its key?
      instructions:
      - text: Get object {key} from object store {bucket}.
        slots:
          key: path.key
          bucket: path.bucket
      - text: Download {key} from bucket {bucket}.
        slots:
          key: path.key
          bucket: path.bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objm/buckets/{bucket}/keys/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload or replace an object
      effect: write
      questions:
      - Can I upload a file into an object store?
      - Will uploading to an existing key replace the object?
      instructions:
      - text: Upload an object as {key} into object store {bucket}.
        slots:
          key: path.key
          bucket: path.bucket
      - text: Replace object {key} in bucket {bucket} with new content.
        slots:
          key: path.key
          bucket: path.bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objm/buckets/{bucket}/keys/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an object from an object store
      effect: destructive
      questions:
      - Can I delete a single file from an object store?
      - Is it possible to purge an object rather than just mark it deleted?
      instructions:
      - text: Delete object {key} from object store {bucket}.
        slots:
          key: path.key
          bucket: path.bucket
      - text: Delete object {key} in bucket {bucket} with purge={purge}.
        slots:
          key: path.key
          bucket: path.bucket
          purge: query.purge
      method: generated
      generated: '2026-10-01'