Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Server Workload API

7 actions 7 updates phrasing extends openapi/aembit-server-workload-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/server-workloads'].get

$.paths['/api/v1/server-workloads'].put

$.paths['/api/v1/server-workloads'].post

$.paths['/api/v1/server-workloads/{id}'].get

$.paths['/api/v1/server-workloads/{id}'].delete

$.paths['/api/v1/server-workloads/{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 Server Workload API
  version: 1.0.0
extends: openapi/aembit-server-workload-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/server-workloads'].get
  update:
    x-apievangelist-phrasing:
      intent: List server workloads
      effect: read
      questions:
      - Which server workloads (target services) are defined?
      - Can I filter or group server workloads?
      - How do I list server workloads in one resource set?
      instructions:
      - text: List my server workloads.
      - text: List server workloads matching {filter}.
        slots:
          filter: query.filter
      - text: Show server workloads in resource set {resourceSet}.
        slots:
          resourceSet: header.X-Aembit-ResourceSet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/server-workloads'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a server workload
      effect: write
      questions:
      - How do I change the service endpoint of a server workload?
      - Can I fully redefine an existing server workload?
      instructions:
      - text: Update server workload {name} to endpoint {endpoint}.
        slots:
          name: requestBody.name
          endpoint: requestBody.serviceEndpoint
      - text: Replace server workload {name} in resource set {resourceSet}.
        slots:
          name: requestBody.name
          resourceSet: requestBody.resourceSet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/server-workloads'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a server workload
      effect: write
      questions:
      - How do I register a service that client workloads will call?
      - What endpoint details does a new server workload need?
      instructions:
      - text: Create server workload {name} at endpoint {endpoint}.
        slots:
          name: requestBody.name
          endpoint: requestBody.serviceEndpoint
      - text: Add a new server workload {name} in resource set {resourceSet}.
        slots:
          name: requestBody.name
          resourceSet: requestBody.resourceSet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/server-workloads/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a server workload
      effect: read
      questions:
      - What service endpoint does a specific server workload point to?
      - How many access policies target this server workload?
      instructions:
      - text: Show server workload {id}.
        slots:
          id: path.id
      - text: Get the service endpoint of server workload {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/server-workloads/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a server workload
      effect: destructive
      questions:
      - Can I remove a server workload that was retired?
      - What is the call to delete a server workload by ID?
      instructions:
      - text: Delete server workload {id}.
        slots:
          id: path.id
      - text: Remove the retired server workload {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/server-workloads/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or toggle a server workload
      effect: write
      questions:
      - Can I deactivate a server workload without deleting it?
      - Is it possible to change only a server workload's tags?
      instructions:
      - text: Deactivate server workload {id}.
        slots:
          id: path.id
      - text: Rename server workload {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'