DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT PerfectScale for Commitments AWS API

11 actions 11 updates phrasing extends openapi/doit-perfectscale-for-commitments-aws-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 11

$.info
$.paths['/ps4commitments/v1/aws/organizations'].get
$.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}'].get
$.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}/member-accounts'].get
$.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}/member-accounts/{memberAccountId}'].get
$.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}/savings-plans'].get
$.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}/reserved-instances'].get
$.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}/recommendations'].get
$.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}/recommendations/{serviceId}'].get
$.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}/planned-purchases'].get
$.paths['/ps4commitments/v1/aws/settings'].get

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 PerfectScale for Commitments AWS API
  version: 1.0.0
extends: openapi/doit-perfectscale-for-commitments-aws-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: 10
- target: $.paths['/ps4commitments/v1/aws/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List AWS organizations with commitment stats
      effect: read
      questions:
      - Which AWS Organizations are onboarded for commitment management?
      - What are the trailing 30-day stats across my AWS organizations?
      instructions:
      - text: List my AWS organizations.
      - text: Show AWS organizations with 30-day commitment stats, {n} per page.
        slots:
          n: query.maxResults
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AWS organization overview
      effect: read
      questions:
      - How is commitment coverage trending for one AWS organization?
      - What monthly savings is a specific organization getting?
      instructions:
      - text: Get AWS organization {managementAccountId}.
        slots:
          managementAccountId: path.managementAccountId
      - text: Show the overview stats for organization {managementAccountId}.
        slots:
          managementAccountId: path.managementAccountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}/member-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List member accounts in an organization
      effect: read
      questions:
      - Which member accounts in an organization have commitment coverage?
      - Can I see 30-day stats for each member account?
      instructions:
      - text: List member accounts under organization {managementAccountId}.
        slots:
          managementAccountId: path.managementAccountId
      - text: Show covered member accounts of {managementAccountId}.
        slots:
          managementAccountId: path.managementAccountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}/member-accounts/{memberAccountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a member account overview
      effect: read
      questions:
      - How is one member account doing on commitment savings?
      - What are the trailing stats for a single member account?
      instructions:
      - text: Get member account {memberAccountId} in organization {managementAccountId}.
        slots:
          memberAccountId: path.memberAccountId
          managementAccountId: path.managementAccountId
      - text: Show savings stats for account {memberAccountId} under {managementAccountId}.
        slots:
          memberAccountId: path.memberAccountId
          managementAccountId: path.managementAccountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}/savings-plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List Savings Plans for an organization
      effect: read
      questions:
      - Which Savings Plans does an organization have?
      - Can I filter Savings Plans by type or state?
      instructions:
      - text: List Savings Plans for organization {managementAccountId}.
        slots:
          managementAccountId: path.managementAccountId
      - text: List {status} Savings Plans of type {type} in {managementAccountId}.
        slots:
          status: query.status
          type: query.type
          managementAccountId: path.managementAccountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}/reserved-instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List Reserved Instances for an organization
      effect: read
      questions:
      - Which Reserved Instances does an organization hold?
      - Can I filter Reserved Instances by region or instance family?
      instructions:
      - text: List Reserved Instances for organization {managementAccountId}.
        slots:
          managementAccountId: path.managementAccountId
      - text: List Reserved Instances in {region} of family {instanceFamily} for {managementAccountId}.
        slots:
          region: query.region
          instanceFamily: query.instanceFamily
          managementAccountId: path.managementAccountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}/recommendations'].get
  update:
    x-apievangelist-phrasing:
      intent: List commitment purchase recommendations
      effect: read
      questions:
      - What commitments should an organization buy?
      - Are there purchase recommendations per service for an organization?
      instructions:
      - text: List commitment recommendations for organization {managementAccountId}.
        slots:
          managementAccountId: path.managementAccountId
      - text: Show what {managementAccountId} should purchase.
        slots:
          managementAccountId: path.managementAccountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}/recommendations/{serviceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one service recommendation in detail
      effect: read
      questions:
      - What analysis backs the recommendation for a specific service?
      - Can I view a recommendation at a different granularity?
      instructions:
      - text: Get the {serviceId} recommendation for organization {managementAccountId}.
        slots:
          serviceId: path.serviceId
          managementAccountId: path.managementAccountId
      - text: Show {granularity} analysis for the {serviceId} recommendation in {managementAccountId}.
        slots:
          granularity: query.granularity
          serviceId: path.serviceId
          managementAccountId: path.managementAccountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ps4commitments/v1/aws/organizations/{managementAccountId}/planned-purchases'].get
  update:
    x-apievangelist-phrasing:
      intent: List planned commitment purchases
      effect: read
      questions:
      - What commitment purchases are planned for an organization?
      - Can I see the laddering projection for compute or database separately?
      instructions:
      - text: List planned purchases for organization {managementAccountId}.
        slots:
          managementAccountId: path.managementAccountId
      - text: Show the {service} purchase ladder for {managementAccountId}.
        slots:
          service: query.service
          managementAccountId: path.managementAccountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ps4commitments/v1/aws/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List commitment engine settings
      effect: read
      questions:
      - How is automation configured for each onboarded organization?
      - What recommendation engine settings apply to compute versus database?
      instructions:
      - text: List engine settings for all onboarded organizations.
      - text: Show automation and recommendation settings, {n} per page.
        slots:
          n: query.maxResults
      method: generated
      generated: '2026-10-01'