Synadia Communications · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NATS HTTP Gateway ObjectStore API

4 actions 4 updates phrasing extends openapi/synadia-communications-objectstore-api-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['/obj/{bucket}/{key}'].get

$.paths['/obj/{bucket}/{key}'].put

$.paths['/obj/{bucket}/{key}'].delete

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 NATS HTTP Gateway ObjectStore API
  version: 1.0.0
extends: openapi/synadia-communications-objectstore-api-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['/obj/{bucket}/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an object from a bucket
      effect: read
      questions:
      - How do I fetch a stored object by bucket and name?
      - Can I get just an object's metadata without downloading its content?
      instructions:
      - text: Get object {key} from bucket {bucket}.
        slots:
          bucket: path.bucket
          key: path.key
      - text: Fetch only the metadata of object {key} in bucket {bucket} with metaOnly={meta}.
        slots:
          bucket: path.bucket
          key: path.key
          meta: query.metaOnly
      method: generated
      generated: '2026-10-01'
- target: $.paths['/obj/{bucket}/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload or replace an object
      effect: write
      questions:
      - How do I upload a file into an object store bucket?
      - Can I only replace an object if it is still at a known revision?
      instructions:
      - text: Upload object {key} to bucket {bucket}.
        slots:
          bucket: path.bucket
          key: path.key
      - text: Replace object {key} in bucket {bucket} only if its revision is {previous}.
        slots:
          bucket: path.bucket
          key: path.key
          previous: query.previousRevision
      method: generated
      generated: '2026-10-01'
- target: $.paths['/obj/{bucket}/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an object from a bucket
      effect: destructive
      questions:
      - How do I delete a stored object from an object bucket?
      - Can I remove one file from an object store without touching the bucket?
      instructions:
      - text: Delete object {key} from bucket {bucket}.
        slots:
          bucket: path.bucket
          key: path.key
      - text: Remove file {key} from object bucket {bucket}.
        slots:
          bucket: path.bucket
          key: path.key
      method: generated
      generated: '2026-10-01'