Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Resource Set API

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

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 Resource Set API
  version: 1.0.0
extends: openapi/aembit-resource-set-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/resource-sets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a resource set
      effect: read
      questions:
      - How many workloads and policies live in a given resource set?
      - Which roles and users have access to a resource set?
      instructions:
      - text: Show resource set {id}.
        slots:
          id: path.id
      - text: Get the workload and policy counts for resource set {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/resource-sets/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a resource set
      effect: destructive
      questions:
      - Can I delete a resource set I no longer use?
      - What is the call to remove a resource set by ID?
      instructions:
      - text: Delete resource set {id}.
        slots:
          id: path.id
      - text: Remove the resource set with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/resource-sets/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or toggle a resource set
      effect: write
      questions:
      - Can I deactivate a resource set without deleting it?
      - Is it possible to rename a resource set?
      instructions:
      - text: Deactivate resource set {id}.
        slots:
          id: path.id
      - text: Rename resource set {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/resource-sets'].get
  update:
    x-apievangelist-phrasing:
      intent: List resource sets
      effect: read
      questions:
      - Which resource sets partition my tenant?
      - Can I filter or group resource sets?
      instructions:
      - text: List my resource sets.
      - text: List resource sets matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/resource-sets'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a resource set
      effect: write
      questions:
      - How do I change which roles and users belong to a resource set?
      - Can I assign a standalone certificate authority to an existing resource set?
      instructions:
      - text: Update resource set {name} with roles {roles}.
        slots:
          name: requestBody.name
          roles: requestBody.roles
      - text: Replace resource set {name} and give access to users {users}.
        slots:
          name: requestBody.name
          users: requestBody.users
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/resource-sets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a resource set
      effect: write
      questions:
      - How do I create a resource set to isolate a team's workloads?
      - Can I assign roles and users when creating a resource set?
      instructions:
      - text: Create a resource set named {name}.
        slots:
          name: requestBody.name
      - text: Create resource set {name} with roles {roles} and users {users}.
        slots:
          name: requestBody.name
          roles: requestBody.roles
          users: requestBody.users
      method: generated
      generated: '2026-09-26'