Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Log Stream API

7 actions 7 updates phrasing extends openapi/aembit-log-stream-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Aembit's API. It is a proposal applied on top of the contract, not a document Aembit publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/api/v1/log-streams'].get

$.paths['/api/v1/log-streams'].put

$.paths['/api/v1/log-streams'].post

$.paths['/api/v1/log-streams/{id}'].get

$.paths['/api/v1/log-streams/{id}'].delete

$.paths['/api/v1/log-streams/{id}'].patch

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 Aembit Cloud Log Stream API
  version: 1.0.0
extends: openapi/aembit-log-stream-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/api/v1/log-streams'].get
  update:
    x-apievangelist-phrasing:
      intent: List log streams
      effect: read
      questions:
      - Where are my Aembit logs being streamed?
      - Can I filter the list of log streams?
      instructions:
      - text: List my log streams.
      - text: List log streams matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/log-streams'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a log stream
      effect: write
      questions:
      - How do I fully update a log stream's destination settings?
      - Can I overwrite an existing log stream configuration?
      instructions:
      - text: Replace a log stream's configuration.
      - text: Overwrite the settings of an existing log stream.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/log-streams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a log stream
      effect: write
      questions:
      - How do I start exporting events to an external log destination?
      - Can I set up a new log stream?
      instructions:
      - text: Create a log stream.
      - text: Set up a new log stream for my tenant's events.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/log-streams/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a log stream
      effect: read
      questions:
      - What destination is a particular log stream sending to?
      - Can I read one log stream by ID?
      instructions:
      - text: Show log stream {id}.
        slots:
          id: path.id
      - text: Get the configuration of log stream {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/log-streams/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a log stream
      effect: destructive
      questions:
      - Can I stop and remove a log stream?
      - What is the call to delete a log stream by ID?
      instructions:
      - text: Delete log stream {id}.
        slots:
          id: path.id
      - text: Remove the log stream with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/log-streams/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Pause, rename or retag a log stream
      effect: write
      questions:
      - Can I pause a log stream without deleting it?
      - Is it possible to rename a log stream?
      instructions:
      - text: Deactivate log stream {id}.
        slots:
          id: path.id
      - text: Rename log stream {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'