Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Routing API

6 actions 6 updates phrasing extends openapi/aembit-routing-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 6

$.info

$.paths['/api/v1/routings/{id}'].get

$.paths['/api/v1/routings/{id}'].patch

$.paths['/api/v1/routings'].get

$.paths['/api/v1/routings'].put

$.paths['/api/v1/routings'].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 Aembit Cloud Routing API
  version: 1.0.0
extends: openapi/aembit-routing-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: 5
- target: $.paths['/api/v1/routings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a routing
      effect: read
      questions:
      - Which proxy URL does a routing send traffic through?
      - Can I read one routing by its ID?
      instructions:
      - text: Show routing {id}.
        slots:
          id: path.id
      - text: Get the proxy settings of routing {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/routings/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or toggle a routing
      effect: write
      questions:
      - Can I disable a routing without deleting it?
      - Is it possible to rename a routing?
      instructions:
      - text: Deactivate routing {id}.
        slots:
          id: path.id
      - text: Rename routing {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/routings'].get
  update:
    x-apievangelist-phrasing:
      intent: List routings
      effect: read
      questions:
      - Which routings are configured in my tenant?
      - Can I filter the list of routings?
      instructions:
      - text: List my routings.
      - text: List routings matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/routings'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a routing
      effect: write
      questions:
      - How do I change the proxy URL of an existing routing?
      - Can I move a routing to another resource set?
      instructions:
      - text: Update routing {name} to use proxy {proxyUrl}.
        slots:
          name: requestBody.name
          proxyUrl: requestBody.proxyUrl
      - text: Replace routing {name} for resource set {resourceSetId}.
        slots:
          name: requestBody.name
          resourceSetId: requestBody.resourceSetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/routings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a routing
      effect: write
      questions:
      - How do I route a resource set's traffic through a proxy?
      - What does a new routing need?
      instructions:
      - text: Create routing {name} through proxy {proxyUrl} for resource set {resourceSetId}.
        slots:
          name: requestBody.name
          proxyUrl: requestBody.proxyUrl
          resourceSetId: requestBody.resourceSetId
      - text: Add a new routing called {name} with proxy URL {proxyUrl}.
        slots:
          name: requestBody.name
          proxyUrl: requestBody.proxyUrl
      method: generated
      generated: '2026-09-26'