Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness License Usage Resource API

3 actions 3 updates phrasing extends openapi/harness-licenseusageresource-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Harness's API. It is a proposal applied on top of the contract, not a document Harness publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v1/license/usage/save'].post

$.paths['/v1/license/ssca/usage'].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 Harness License Usage Resource API
  version: 1.0.0
extends: openapi/harness-licenseusageresource-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: 2
- target: $.paths['/v1/license/usage/save'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a user's Internal Developer Portal license usage
      effect: write
      questions:
      - How do I record that a developer accessed the Internal Developer Portal for license counting?
      - What user details are needed to save IDP license usage?
      instructions:
      - text: Record IDP usage for {user_name} ({email}, ID {user_id}) accessed at {accessed_at}.
        slots:
          user_name: requestBody.user_name
          email: requestBody.email
          user_id: requestBody.user_identifier
          accessed_at: requestBody.accessed_at
      - text: 'Save an IDP license usage entry: user {user_id}, name {user_name}, email {email}, time {accessed_at}.'
        slots:
          user_id: requestBody.user_identifier
          user_name: requestBody.user_name
          email: requestBody.email
          accessed_at: requestBody.accessed_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/license/ssca/usage'].post
  update:
    x-apievangelist-phrasing:
      intent: Get supply chain security module license usage
      effect: read
      questions:
      - How much of our supply chain security license are we using?
      - Can I check SSCA license usage as of a particular timestamp?
      instructions:
      - text: Show SSCA license usage for account {account}.
        slots:
          account: header.Harness-Account
      - text: Get SSCA license usage for account {account} at {timestamp}.
        slots:
          account: header.Harness-Account
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'