Synadia Communications · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NATS HTTP Gateway NATS Core Messaging (Experimental) API

4 actions 4 updates phrasing extends openapi/synadia-communications-nats-core-messaging-experimental-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['/nats/subjects/{subject}'].get

$.paths['/nats/subjects/{subject}'].put

$.paths['/nats/subjects/{subject}'].post

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 NATS Core Messaging (Experimental) API
  version: 1.0.0
extends: openapi/synadia-communications-nats-core-messaging-experimental-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['/nats/subjects/{subject}'].get
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to a subject and receive messages
      effect: read
      questions:
      - Can I receive messages published to a subject over HTTP?
      - Is there a way to cap how many messages a subscription returns or how long it waits?
      instructions:
      - text: Subscribe to subject {subject}.
        slots:
          subject: path.subject
      - text: Collect up to {limit} messages from {subject} within {timeout}.
        slots:
          limit: query.limit
          subject: path.subject
          timeout: query.timeout
      method: generated
      generated: '2026-10-01'
- target: $.paths['/nats/subjects/{subject}'].put
  update:
    x-apievangelist-phrasing:
      intent: Publish a message to a subject
      effect: write
      questions:
      - How do I publish a message to a NATS subject over HTTP?
      - Can I set a reply subject when publishing?
      instructions:
      - text: Publish a message to {subject} with reply subject {reply}.
        slots:
          subject: path.subject
          reply: query.reply
      - text: Send a message on subject {subject} and set the reply-to as {reply}.
        slots:
          subject: path.subject
          reply: query.reply
      method: generated
      generated: '2026-10-01'
- target: $.paths['/nats/subjects/{subject}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a request and wait for a reply
      effect: write
      questions:
      - Can I do request-reply against a NATS service over HTTP?
      - How long will a request wait for a responder?
      instructions:
      - text: Send a request to {subject} and return the reply.
        slots:
          subject: path.subject
      - text: Request {subject} with a timeout of {timeout}.
        slots:
          subject: path.subject
          timeout: query.timeout
      method: generated
      generated: '2026-10-01'