DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Cloud Connect API

6 actions 6 updates phrasing extends openapi/doit-cloud-connect-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 6

$.info

$.paths['/core/v1/cloudconnect/supportedFeatures/{accountID}'].get

$.paths['/core/v1/cloudconnect/aws/accounts'].post

$.paths['/core/v1/cloudconnect/aws/accounts/{accountID}'].get

$.paths['/core/v1/cloudconnect/aws/accounts/{accountID}'].put

$.paths['/core/v1/cloudconnect/aws/accounts/{accountID}'].delete

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 DoiT Cloud Connect API
  version: 1.0.0
extends: openapi/doit-cloud-connect-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: 5
- target: $.paths['/core/v1/cloudconnect/supportedFeatures/{accountID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check feature permissions for a connected account
      effect: read
      questions:
      - Which features are permitted for a cloud account connected to DoiT?
      - Is a connected account missing permissions for any feature?
      instructions:
      - text: List supported features for connected account {accountID}.
        slots:
          accountID: path.accountID
      - text: Check feature permission status on account {accountID}.
        slots:
          accountID: path.accountID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/v1/cloudconnect/aws/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect an AWS account role
      effect: write
      questions:
      - How do I connect an AWS account to DoiT with an IAM role?
      - Can I set an S3 bucket when connecting the account?
      instructions:
      - text: Connect AWS account {accountID} with role {roleArn} and features {enabledFeatures}.
        slots:
          accountID: requestBody.accountID
          roleArn: requestBody.roleArn
          enabledFeatures: requestBody.enabledFeatures
      - text: Register role {roleArn} for account {accountID}, bucket {s3Bucket}, features {enabledFeatures}.
        slots:
          accountID: requestBody.accountID
          roleArn: requestBody.roleArn
          s3Bucket: requestBody.s3Bucket
          enabledFeatures: requestBody.enabledFeatures
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/v1/cloudconnect/aws/accounts/{accountID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connected AWS account
      effect: read
      questions:
      - What role and S3 bucket is configured for a connected AWS account?
      - How do I check the current state of one AWS account connection?
      instructions:
      - text: Get connected AWS account {accountID}.
        slots:
          accountID: path.accountID
      - text: Show the role and bucket config for AWS account {accountID}.
        slots:
          accountID: path.accountID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/v1/cloudconnect/aws/accounts/{accountID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change enabled features on an AWS account
      effect: write
      questions:
      - How do I enable more features on an already connected AWS account?
      - Can I change the S3 bucket for an existing connection?
      instructions:
      - text: Set enabled features on AWS account {accountID} to {enabledFeatures}.
        slots:
          accountID: path.accountID
          enabledFeatures: requestBody.enabledFeatures
      - text: Update AWS account {accountID} bucket to {s3Bucket} with features {enabledFeatures}.
        slots:
          accountID: path.accountID
          s3Bucket: requestBody.s3Bucket
          enabledFeatures: requestBody.enabledFeatures
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/v1/cloudconnect/aws/accounts/{accountID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disconnect an AWS account role
      effect: destructive
      questions:
      - How do I disconnect an AWS account from DoiT?
      - Can I remove the role connection for one account?
      instructions:
      - text: Disconnect AWS account {accountID}.
        slots:
          accountID: path.accountID
      - text: Delete the account role for {accountID}.
        slots:
          accountID: path.accountID
      method: generated
      generated: '2026-10-01'