Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Integration API

7 actions 7 updates phrasing extends openapi/aembit-integration-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/integrations'].get
$.paths['/api/v1/integrations'].put
$.paths['/api/v1/integrations'].post
$.paths['/api/v1/integrations/{id}'].get
$.paths['/api/v1/integrations/{id}'].delete
$.paths['/api/v1/integrations/{id}'].patch

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 Integration API
  version: 1.0.0
extends: openapi/aembit-integration-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/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List integrations
      effect: read
      questions:
      - Which integrations are connected to my tenant?
      - Can I filter integrations in a resource set?
      instructions:
      - text: List my integrations.
      - text: List integrations matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/integrations'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an integration
      effect: write
      questions:
      - How do I change how often an integration syncs?
      - Can I change the endpoint an existing integration pulls from?
      instructions:
      - text: Update integration {name} to sync every {seconds} seconds.
        slots:
          name: requestBody.name
          seconds: requestBody.syncFrequencySeconds
      - text: Replace integration {name} with endpoint {endpoint}.
        slots:
          name: requestBody.name
          endpoint: requestBody.endpoint
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an integration
      effect: write
      questions:
      - How do I connect an integration that access conditions can use?
      - What settings are required to create an integration?
      instructions:
      - text: Create integration {name} of type {type} at endpoint {endpoint}.
        slots:
          name: requestBody.name
          type: requestBody.type
          endpoint: requestBody.endpoint
      - text: Add integration {name} with configuration {config}.
        slots:
          name: requestBody.name
          config: requestBody.integrationJSON
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/integrations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration
      effect: read
      questions:
      - When did an integration last sync?
      - How many access conditions rely on one integration?
      instructions:
      - text: Show integration {id}.
        slots:
          id: path.id
      - text: Check the sync status of integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/integrations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration
      effect: destructive
      questions:
      - Can I disconnect and delete an integration?
      - What is the way to delete an integration by ID?
      instructions:
      - text: Delete integration {id}.
        slots:
          id: path.id
      - text: Remove the integration with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/integrations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or toggle an integration
      effect: write
      questions:
      - Can I pause an integration without deleting it?
      - Is it possible to change only an integration's tags?
      instructions:
      - text: Deactivate integration {id}.
        slots:
          id: path.id
      - text: Rename integration {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'