# 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 Management API
  version: 1.0.0
extends: openapi/synadia-communications-objectstore-management-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: 6
- target: $.paths['/objm/buckets'].get
  update:
    x-apievangelist-phrasing:
      intent: List all object stores
      effect: read
      questions:
      - What object store buckets do I have?
      - Can I list every object store in the account?
      instructions:
      - text: List all object stores.
      - text: Show me my object store buckets.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objm/buckets/{bucket}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object store's metadata
      effect: read
      questions:
      - How big is an object store and what are its settings?
      - Can I see the metadata of one object store bucket?
      instructions:
      - text: Show metadata for object store {bucket}.
        slots:
          bucket: path.bucket
      - text: Get info about object store bucket {bucket}.
        slots:
          bucket: path.bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objm/buckets/{bucket}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an object store
      effect: write
      questions:
      - How do I create a new object store bucket?
      - Can I set a TTL, size limit, replicas or compression on a new object store?
      instructions:
      - text: Create object store {bucket}.
        slots:
          bucket: path.bucket
      - text: Create object store {bucket} with {replicas} replicas and max size {max_bytes}.
        slots:
          bucket: path.bucket
          replicas: requestBody.replicas
          max_bytes: requestBody.max_bytes
      - text: Add object store {bucket} with a TTL of {ttl} on {storage} storage.
        slots:
          bucket: path.bucket
          ttl: requestBody.ttl
          storage: requestBody.storage
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objm/buckets/{bucket}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an object store and all its objects
      effect: destructive
      questions:
      - Can I delete an entire object store including every object in it?
      - What's the way to destroy an object store bucket?
      instructions:
      - text: Delete object store {bucket} and all its keys.
        slots:
          bucket: path.bucket
      - text: Destroy object store bucket {bucket}.
        slots:
          bucket: path.bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objm/buckets/{bucket}/keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List the objects in an object store
      effect: read
      questions:
      - What objects are stored in my object store?
      - Can I list every key in an object store bucket?
      instructions:
      - text: List the keys in object store {bucket}.
        slots:
          bucket: path.bucket
      - text: Show all objects stored in bucket {bucket}.
        slots:
          bucket: path.bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objm/buckets/{bucket}/watch'].get
  update:
    x-apievangelist-phrasing:
      intent: Watch an object store for changes
      effect: read
      questions:
      - Can I get notified as objects change in an object store?
      - Is it possible to resume watching from a given revision and ignore deletes?
      instructions:
      - text: Watch object store {bucket} for changes.
        slots:
          bucket: path.bucket
      - text: Watch object store {bucket} for changes matching {filter}.
        slots:
          bucket: path.bucket
          filter: query.filter
      - text: Resume watching object store {bucket} from revision {resumeRevision}.
        slots:
          bucket: path.bucket
          resumeRevision: query.resumeRevision
      method: generated
      generated: '2026-10-01'