Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Workload Event API

3 actions 3 updates phrasing extends openapi/aembit-workload-event-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 3

$.info
$.paths['/api/v1/workload-events'].get
$.paths['/api/v1/workload-events/{id}'].get

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 Aembit Cloud Workload Event API
  version: 1.0.0
extends: openapi/aembit-workload-event-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: 2
- target: $.paths['/api/v1/workload-events'].get
  update:
    x-apievangelist-phrasing:
      intent: List workload events
      effect: read
      questions:
      - Which workloads talked to each other in the last hour?
      - Can I filter workload events by source or target workload?
      - What workload events did one user trigger?
      instructions:
      - text: Show workload events from the last {hours} hours.
        slots:
          hours: query.span-last-hours
      - text: List workload events from {source} to {target}.
        slots:
          source: query.source-workload
          target: query.target-workload
      - text: List workload events over protocol {protocol} with severity {severity}.
        slots:
          protocol: query.application-protocol
          severity: query.severity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/workload-events/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one workload event
      effect: read
      questions:
      - What happened in a specific workload event?
      - Can I look up one workload event by ID?
      instructions:
      - text: Open workload event {id}.
        slots:
          id: path.id
      - text: Show the details of workload event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'