Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Standalone Certificate Authority API

7 actions 7 updates phrasing extends openapi/aembit-standalone-certificate-authority-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/certificate-authorities/{id}'].get

$.paths['/api/v1/certificate-authorities/{id}'].delete

$.paths['/api/v1/certificate-authorities/{id}'].patch

$.paths['/api/v1/certificate-authorities'].get

$.paths['/api/v1/certificate-authorities'].put

$.paths['/api/v1/certificate-authorities'].post

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 Standalone Certificate Authority API
  version: 1.0.0
extends: openapi/aembit-standalone-certificate-authority-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/certificate-authorities/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a standalone certificate authority
      effect: read
      questions:
      - What leaf certificate lifetime does a standalone CA use?
      - Can I read one standalone certificate authority by ID?
      instructions:
      - text: Show standalone certificate authority {id}.
        slots:
          id: path.id
      - text: Get the leaf lifetime of standalone CA {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/certificate-authorities/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a standalone certificate authority
      effect: destructive
      questions:
      - Can I delete a standalone certificate authority?
      - What is the call to remove a standalone CA by ID?
      instructions:
      - text: Delete standalone certificate authority {id}.
        slots:
          id: path.id
      - text: Remove standalone CA {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/certificate-authorities/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a standalone CA's leaf lifetime or name
      effect: write
      questions:
      - Can I shorten the lifetime of leaf certificates issued by a standalone CA?
      - Is it possible to deactivate a standalone CA without deleting it?
      instructions:
      - text: Set the leaf lifetime of standalone CA {id} to {leafLifetime}.
        slots:
          id: path.id
          leafLifetime: requestBody.leafLifetime
      - text: Deactivate standalone certificate authority {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/certificate-authorities'].get
  update:
    x-apievangelist-phrasing:
      intent: List standalone certificate authorities
      effect: read
      questions:
      - Which standalone certificate authorities exist?
      - Can I filter the standalone CA list?
      instructions:
      - text: List my standalone certificate authorities.
      - text: List standalone CAs matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/certificate-authorities'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a standalone certificate authority
      effect: write
      questions:
      - How do I fully update a standalone certificate authority?
      - Can I move a standalone CA to another resource set?
      instructions:
      - text: Replace standalone CA {name} with leaf lifetime {leafLifetime}.
        slots:
          name: requestBody.name
          leafLifetime: requestBody.leafLifetime
      - text: Update standalone certificate authority {name} in resource set {resourceSet}.
        slots:
          name: requestBody.name
          resourceSet: requestBody.resourceSet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/certificate-authorities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a standalone certificate authority
      effect: write
      questions:
      - How do I create a standalone certificate authority for a resource set?
      - What leaf certificate lifetime should I set on a new standalone CA?
      instructions:
      - text: Create standalone CA {name} with leaf lifetime {leafLifetime}.
        slots:
          name: requestBody.name
          leafLifetime: requestBody.leafLifetime
      - text: Create a standalone certificate authority {name} for resource set {resourceSet}.
        slots:
          name: requestBody.name
          resourceSet: requestBody.resourceSet
      method: generated
      generated: '2026-09-26'