DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Assets API

5 actions 5 updates phrasing extends openapi/doit-assets-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for DoiT's API. It is a proposal applied on top of the contract, not a document DoiT publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/billing/v1/createAsset'].post
$.paths['/billing/v1/assets'].get
$.paths['/billing/v1/assets/{id}'].get
$.paths['/billing/v1/assets/{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 DoiT Assets API
  version: 1.0.0
extends: openapi/doit-assets-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/billing/v1/createAsset'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a billing asset
      effect: write
      questions:
      - How do I create a new account asset through DoiT?
      - Can I set the root email and account name when creating an asset?
      instructions:
      - text: Create a {type} asset named {accountName} with root email {rootEmail}.
        slots:
          type: query.type
          accountName: query.accountName
          rootEmail: query.rootEmail
      - text: Create a new asset of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/billing/v1/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List billing assets
      effect: read
      questions:
      - Which billing accounts and subscriptions does DoiT manage for us?
      - Can I filter the assets list?
      instructions:
      - text: List all our assets.
      - text: List assets matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/billing/v1/assets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an asset
      effect: read
      questions:
      - How do I see the full details of one asset?
      - What does a single billing account asset record contain?
      instructions:
      - text: Get asset {id}.
        slots:
          id: path.id
      - text: Show the details of asset {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/billing/v1/assets/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change license count on a subscription
      effect: write
      questions:
      - How do I add or remove Workspace licenses?
      - Can I change the seat quantity on an Office 365 subscription?
      instructions:
      - text: Set the license quantity of asset {id} to {quantity}.
        slots:
          id: path.id
          quantity: requestBody.quantity
      - text: Change asset {id} to {quantity} licenses.
        slots:
          id: path.id
          quantity: requestBody.quantity
      method: generated
      generated: '2026-10-01'