Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Discovery Integration API

7 actions 7 updates phrasing extends openapi/aembit-discoveryintegration-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/discovery-integrations'].get
$.paths['/api/v1/discovery-integrations'].put
$.paths['/api/v1/discovery-integrations'].post
$.paths['/api/v1/discovery-integrations/{id}'].get
$.paths['/api/v1/discovery-integrations/{id}'].delete
$.paths['/api/v1/discovery-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 Discovery Integration API
  version: 1.0.0
extends: openapi/aembit-discoveryintegration-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/discovery-integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List discovery integrations
      effect: read
      questions:
      - Which discovery integrations are set up to find workloads?
      - Can I filter discovery integrations?
      instructions:
      - text: List my discovery integrations.
      - text: List discovery integrations matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/discovery-integrations'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a discovery integration
      effect: write
      questions:
      - How do I change the sync frequency of a discovery integration?
      - Can I point an existing discovery integration at a new endpoint?
      instructions:
      - text: Update discovery integration {name} to sync every {seconds} seconds.
        slots:
          name: requestBody.name
          seconds: requestBody.syncFrequencySeconds
      - text: Replace discovery integration {name} with endpoint {endpoint}.
        slots:
          name: requestBody.name
          endpoint: requestBody.endpoint
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/discovery-integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a discovery integration
      effect: write
      questions:
      - How do I set up a discovery integration to find workloads automatically?
      - What do I need to supply to create a discovery integration?
      instructions:
      - text: Create discovery integration {name} of type {type} at {endpoint}.
        slots:
          name: requestBody.name
          type: requestBody.type
          endpoint: requestBody.endpoint
      - text: Add a discovery integration {name} that syncs every {seconds} seconds.
        slots:
          name: requestBody.name
          seconds: requestBody.syncFrequencySeconds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/discovery-integrations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a discovery integration
      effect: read
      questions:
      - When did a discovery integration last sync and did it succeed?
      - Can I read one discovery integration by ID?
      instructions:
      - text: Show discovery integration {id}.
        slots:
          id: path.id
      - text: Check the last sync status of discovery integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/discovery-integrations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a discovery integration
      effect: destructive
      questions:
      - Can I remove a discovery integration?
      - What is the call to delete a discovery integration by ID?
      instructions:
      - text: Delete discovery integration {id}.
        slots:
          id: path.id
      - text: Remove the discovery integration with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/discovery-integrations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or toggle a discovery integration
      effect: write
      questions:
      - Can I pause a discovery integration without deleting it?
      - Is it possible to rename a discovery integration?
      instructions:
      - text: Deactivate discovery integration {id}.
        slots:
          id: path.id
      - text: Rename discovery integration {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'