Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Access Condition API

7 actions 7 updates phrasing extends openapi/aembit-access-condition-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/access-conditions'].get
$.paths['/api/v1/access-conditions'].put
$.paths['/api/v1/access-conditions'].post
$.paths['/api/v1/access-conditions/{id}'].get
$.paths['/api/v1/access-conditions/{id}'].delete
$.paths['/api/v1/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 API
  version: 1.0.0
extends: openapi/aembit-access-condition-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/access-conditions'].get
  update:
    x-apievangelist-phrasing:
      intent: List access conditions
      effect: read
      questions:
      - Which access conditions are defined in my tenant?
      - Can I group or filter the access conditions list?
      - How do I page through all access conditions?
      instructions:
      - text: List my access conditions.
      - text: List access conditions matching {filter}.
        slots:
          filter: query.filter
      - text: Show page {page} of access conditions.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/access-conditions'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an access condition's full definition
      effect: write
      questions:
      - How do I overwrite an existing access condition with a new set of rules?
      - Does a full update of an access condition require its conditions and resource set?
      instructions:
      - text: Replace the access condition named {name} with conditions {conditions}.
        slots:
          name: requestBody.name
          conditions: requestBody.conditions
      - text: 'Fully update access condition {name} and set it active: {active}.'
        slots:
          name: requestBody.name
          active: requestBody.isActive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/access-conditions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an access condition
      effect: write
      questions:
      - How do I create a new access condition to attach to an access policy?
      - Can an access condition be tied to an integration when I create it?
      instructions:
      - text: Create an access condition called {name} with conditions {conditions}.
        slots:
          name: requestBody.name
          conditions: requestBody.conditions
      - text: Add a new access condition {name} in resource set {resourceSet}.
        slots:
          name: requestBody.name
          resourceSet: requestBody.resourceSet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/access-conditions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an access condition
      effect: read
      questions:
      - What rules does a specific access condition enforce?
      - Where can I see how many policies use one access condition?
      instructions:
      - text: Show access condition {id}.
        slots:
          id: path.id
      - text: Fetch the details of access condition {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/access-conditions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an access condition
      effect: destructive
      questions:
      - Can I remove an access condition I no longer need?
      - What happens when I delete an access condition by ID?
      instructions:
      - text: Delete access condition {id}.
        slots:
          id: path.id
      - text: Remove the access condition with ID {id} from my tenant.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/access-conditions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or toggle an access condition
      effect: write
      questions:
      - Can I just deactivate an access condition without redefining it?
      - Is it possible to change only the name or tags on an access condition?
      instructions:
      - text: Deactivate access condition {id}.
        slots:
          id: path.id
      - text: Rename access condition {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the tags on access condition {id} to {tags}.
        slots:
          id: path.id
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'