# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Usage API
  version: 1.0.0
extends: openapi/harness-usage-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: 18
- target: $.paths['/ng/api/license-usage-cd/v2/{usageType}/csv/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the CD license usage CSV report
      effect: read
      questions:
      - How do I export my Continuous Delivery license usage as a CSV?
      - Can I download CD usage broken out by usage type, like services versus service instances?
      instructions:
      - text: Download the CD usage CSV report for usage type {usageType}.
        slots:
          usageType: path.usageType
      - text: Export the {usageType} CD license usage CSV as of {timestamp}.
        slots:
          usageType: path.usageType
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/usage/cd/active-services/csv/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download active CD services CSV (platform)
      effect: read
      questions:
      - Where can I get a CSV of the CD services that counted as active for licensing?
      - Can I pull the platform's active services report as a spreadsheet for a given date?
      instructions:
      - text: Download the platform active services CSV report.
      - text: Export the NG active CD services CSV for timestamp {timestamp}.
        slots:
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/usage/CD/serviceInstancesLicense'].get
  update:
    x-apievangelist-phrasing:
      intent: Get CD service-instance license usage (platform)
      effect: read
      questions:
      - How many CD service instances am I consuming against my license?
      - What does service-instance-based CD license usage look like on the platform endpoint?
      instructions:
      - text: Show my CD service-instance license usage on the platform.
      - text: Get NG service instances license usage for account {accountIdentifier} at {timestamp}.
        slots:
          accountIdentifier: query.accountIdentifier
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/usage/CD/servicesLicense'].get
  update:
    x-apievangelist-phrasing:
      intent: Get CD services license usage (platform)
      effect: read
      questions:
      - How many licensed CD services is my account using right now?
      - What is my services-based CD license consumption from the platform usage endpoint?
      instructions:
      - text: Show my CD services license usage on the platform.
      - text: Get NG services-based license usage for account {accountIdentifier} as of {timestamp}.
        slots:
          accountIdentifier: query.accountIdentifier
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/usage/{module}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get license usage for a module (platform)
      effect: read
      questions:
      - How much of my license is a given Harness module consuming?
      - Can I check usage for a module filtered by CD license type?
      instructions:
      - text: Get platform license usage for module {module}.
        slots:
          module: path.module
      - text: Show NG usage of module {module} for CD license type {CDLicenseType} at {timestamp}.
        slots:
          module: path.module
          CDLicenseType: query.CDLicenseType
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/usage/cd/active-services/csv/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download active CD services CSV via CCM
      effect: read
      questions:
      - Can I get the active services CSV from the Cloud Cost Management service path?
      - Where does the CCM service expose a spreadsheet of active CD services?
      instructions:
      - text: Download the active services CSV through the CCM usage endpoint.
      - text: Export the CCM copy of the active services report for {timestamp}.
        slots:
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/usage/CD/serviceInstancesLicense'].get
  update:
    x-apievangelist-phrasing:
      intent: Get CD service-instance license usage via CCM
      effect: read
      questions:
      - Does the CCM service report CD service-instance license usage too?
      - What service instance consumption does the cost management usage path return?
      instructions:
      - text: Get service instances license usage from the CCM endpoint.
      - text: Show CCM-reported service-instance usage for account {accountIdentifier} at {timestamp}.
        slots:
          accountIdentifier: query.accountIdentifier
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/usage/CD/servicesLicense'].get
  update:
    x-apievangelist-phrasing:
      intent: Get CD services license usage via CCM
      effect: read
      questions:
      - Can the Cloud Cost Management service tell me my CD services license usage?
      - What services-based consumption does the CCM usage path report?
      instructions:
      - text: Get services license usage from the CCM endpoint.
      - text: Show CCM-reported services usage for account {accountIdentifier} at time {timestamp}.
        slots:
          accountIdentifier: query.accountIdentifier
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/usage/{module}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get license usage for a module via CCM
      effect: read
      questions:
      - Can I look up a module's license usage through the CCM service?
      - Does the cost management usage path accept a CD license type filter?
      instructions:
      - text: Get module {module} license usage from the CCM service.
        slots:
          module: path.module
      - text: Show CCM usage of {module} for license type {CDLicenseType}.
        slots:
          module: path.module
          CDLicenseType: query.CDLicenseType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/usage/SRM/active-monitored-services/csv/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download active monitored services CSV (SRM)
      effect: read
      questions:
      - How do I export a CSV of my active monitored services in Service Reliability Management?
      - Can I download the SRM active monitored services report for a past date?
      instructions:
      - text: Download the SRM active monitored services CSV.
      - text: Export active monitored services as CSV for {timestamp}.
        slots:
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/usage/SRM/active-services-monitored/csv/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download active services monitored CSV (SRM)
      effect: read
      questions:
      - Where can I get the SRM 'active services monitored' spreadsheet?
      - Can I export which services counted as monitored for SRM licensing?
      instructions:
      - text: Get the spreadsheet of services monitored under SRM.
      - text: Export the services-monitored SRM CSV for account {accountIdentifier}.
        slots:
          accountIdentifier: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/usage/CV'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Continuous Verification license usage
      effect: read
      questions:
      - How much Continuous Verification license is my account using?
      - Can I check CV usage as of a particular timestamp?
      instructions:
      - text: Get Continuous Verification usage for account {accountIdentifier}.
        slots:
          accountIdentifier: query.accountIdentifier
      - text: Show CV module license usage for {accountIdentifier} at {timestamp}.
        slots:
          accountIdentifier: query.accountIdentifier
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/usage/SRM'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Service Reliability Management license usage
      effect: read
      questions:
      - What is my Service Reliability Management license consumption?
      - Can I see SRM usage totals for my account at a point in time?
      instructions:
      - text: Get SRM license usage for account {accountIdentifier}.
        slots:
          accountIdentifier: query.accountIdentifier
      - text: Show Service Reliability Management usage for {accountIdentifier} as of {timestamp}.
        slots:
          accountIdentifier: query.accountIdentifier
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/usage/SRM/active-monitored-services'].post
  update:
    x-apievangelist-phrasing:
      intent: List active monitored services for SRM
      effect: read
      questions:
      - Which monitored services are currently active and counting toward SRM licensing?
      - Can I filter the active monitored services list by project or service?
      instructions:
      - text: List active monitored services in project {projectIdentifier}.
        slots:
          projectIdentifier: requestBody.projectIdentifier
      - text: Show active monitored service details for service {serviceIdentifier} in org {orgIdentifier}.
        slots:
          serviceIdentifier: requestBody.serviceIdentifier
          orgIdentifier: requestBody.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Report STO usage for an account
      effect: read
      questions:
      - How much Security Testing Orchestration usage has my account recorded?
      - Can I get STO usage for a specific time interval?
      instructions:
      - text: Report STO usage for account {accountId} at {timestamp}.
        slots:
          accountId: query.accountId
          timestamp: query.timestamp
      - text: Show security testing usage for {accountId} over interval {interval} ending {timestamp}.
        slots:
          accountId: query.accountId
          interval: query.interval
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/usage/all-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: Report STO usage across all accounts
      effect: read
      questions:
      - Is there a way to see Security Testing Orchestration usage for every account at once?
      - What STO usage did all accounts record over a given interval?
      instructions:
      - text: Report STO usage for all accounts at {timestamp}.
        slots:
          timestamp: query.timestamp
      - text: Show every account's security testing usage for interval {interval} up to {timestamp}.
        slots:
          interval: query.interval
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/enforcement/client/usage/{metric}'].put
  update:
    x-apievangelist-phrasing:
      intent: Show IaCM usage for one enforcement metric
      effect: read
      questions:
      - How close is my account to an Infrastructure as Code Management usage limit?
      - Can I read the current value of a single IaCM enforcement metric?
      instructions:
      - text: Show IaCM usage for metric {metric} in account {accountIdentifier}.
        slots:
          metric: path.metric
          accountIdentifier: query.accountIdentifier
      - text: Get the enforcement usage value of {metric} for {accountIdentifier}.
        slots:
          metric: path.metric
          accountIdentifier: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/usage/check-licence'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether the account has an IaCM licence
      effect: read
      questions:
      - Is my account currently licensed for Infrastructure as Code Management?
      - How can I verify an IaCM licence is active before running workspaces?
      instructions:
      - text: Check whether account {account} is licensed for IaCM.
        slots:
          account: header.Harness-Account
      - text: Confirm the IaCM licence status of {account}.
        slots:
          account: header.Harness-Account
      method: generated
      generated: '2026-09-26'