Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Integration v2 API

7 actions 7 updates phrasing extends openapi/aembit-integration-v2-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/v2/integrations'].get

$.paths['/api/v2/integrations'].put

$.paths['/api/v2/integrations'].post

$.paths['/api/v2/integrations/{id}'].get

$.paths['/api/v2/integrations/{id}'].delete

$.paths['/api/v2/integrations/{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 Integration v2 API
  version: 1.0.0
extends: openapi/aembit-integration-v2-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/v2/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List integrations (v2)
      effect: read
      questions:
      - Which integrations does the v2 API return?
      - Can I sort integrations in the v2 list?
      instructions:
      - text: List integrations using the v2 API.
      - text: List v2 integrations ordered by {order}.
        slots:
          order: query.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/integrations'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an integration (v2)
      effect: write
      questions:
      - How do I fully update an integration with the v2 API?
      - Can I overwrite an integration in a specific resource set with v2?
      instructions:
      - text: Replace an integration's definition through v2.
      - text: Update a v2 integration in resource set {resourceSet}.
        slots:
          resourceSet: header.X-Aembit-ResourceSet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an integration (v2)
      effect: write
      questions:
      - How do I create an integration with the v2 API?
      - Can I add a v2 integration to a particular resource set?
      instructions:
      - text: Create an integration through the v2 API.
      - text: Create a v2 integration in resource set {resourceSet}.
        slots:
          resourceSet: header.X-Aembit-ResourceSet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/integrations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration (v2)
      effect: read
      questions:
      - What does the v2 API return for one integration?
      - Can I read a single integration by ID with v2?
      instructions:
      - text: Get v2 integration {id}.
        slots:
          id: path.id
      - text: Show integration {id} from the v2 endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/integrations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration (v2)
      effect: destructive
      questions:
      - Can I delete an integration through the v2 API?
      - Is deleting a v2 integration by ID permanent?
      instructions:
      - text: Delete integration {id} using v2.
        slots:
          id: path.id
      - text: Remove v2 integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/integrations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or toggle an integration (v2)
      effect: write
      questions:
      - Can I switch off an integration with a v2 patch?
      - Is it possible to change a v2 integration's description only?
      instructions:
      - text: Turn off integration {id} via v2.
        slots:
          id: path.id
      - text: Change the description of v2 integration {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'