Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Access Condition v2 API

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