Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Agent Controller API

8 actions 8 updates phrasing extends openapi/aembit-agent-controller-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 8

$.info
$.paths['/api/v1/agent-controllers'].get
$.paths['/api/v1/agent-controllers'].put
$.paths['/api/v1/agent-controllers'].post
$.paths['/api/v1/agent-controllers/{id}'].get
$.paths['/api/v1/agent-controllers/{id}'].delete
$.paths['/api/v1/agent-controllers/{id}'].patch
$.paths['/api/v1/agent-controllers/{agentControllerExternalId}/device-code'].post

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 Agent Controller API
  version: 1.0.0
extends: openapi/aembit-agent-controller-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: 7
- target: $.paths['/api/v1/agent-controllers'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent controllers
      effect: read
      questions:
      - Which agent controllers are registered in my tenant?
      - Can I check the TLS status of agent controllers while listing them?
      - How do I filter the agent controller list?
      instructions:
      - text: List my agent controllers.
      - text: List agent controllers and check TLS type {tls}.
        slots:
          tls: query.check-tls-type
      - text: Show agent controllers matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/agent-controllers'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an agent controller
      effect: write
      questions:
      - How do I fully update an agent controller's settings?
      - Can I change the allowed TLS hostname on an agent controller?
      instructions:
      - text: Update agent controller {name} to use trust provider {trustProviderId}.
        slots:
          name: requestBody.name
          trustProviderId: requestBody.trustProviderId
      - text: Set the allowed TLS hostname of agent controller {name} to {hostname}.
        slots:
          name: requestBody.name
          hostname: requestBody.allowedTlsHostname
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/agent-controllers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an agent controller
      effect: write
      questions:
      - How do I register a new agent controller?
      - Can I bind a trust provider to an agent controller when I create it?
      instructions:
      - text: Create an agent controller named {name}.
        slots:
          name: requestBody.name
      - text: Create agent controller {name} attested by trust provider {trustProviderId}.
        slots:
          name: requestBody.name
          trustProviderId: requestBody.trustProviderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/agent-controllers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent controller
      effect: read
      questions:
      - Is a particular agent controller healthy and when did it last report?
      - What version is a given agent controller running?
      instructions:
      - text: Show agent controller {id}.
        slots:
          id: path.id
      - text: Check the health and uptime of agent controller {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/agent-controllers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent controller
      effect: destructive
      questions:
      - Can I remove an agent controller I decommissioned?
      - What is the call to delete an agent controller by ID?
      instructions:
      - text: Delete agent controller {id}.
        slots:
          id: path.id
      - text: Remove the decommissioned agent controller {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/agent-controllers/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Toggle or rebind an agent controller
      effect: write
      questions:
      - Can I switch an agent controller to a different trust provider?
      - Is it possible to just deactivate an agent controller?
      instructions:
      - text: Deactivate agent controller {id}.
        slots:
          id: path.id
      - text: Point agent controller {id} at trust provider {trustProviderId}.
        slots:
          id: path.id
          trustProviderId: requestBody.trustProviderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/agent-controllers/{agentControllerExternalId}/device-code'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a device code for an agent controller
      effect: write
      questions:
      - How do I get a device code to register an agent controller?
      - Can I generate a one-time code to bootstrap an agent controller install?
      instructions:
      - text: Generate a device code for agent controller {externalId}.
        slots:
          externalId: path.agentControllerExternalId
      - text: Create a new registration device code for controller {externalId}.
        slots:
          externalId: path.agentControllerExternalId
      method: generated
      generated: '2026-09-26'