Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Contributors API

6 actions 6 updates phrasing extends openapi/harness-contributors-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 6

$.info

$.paths['/v1/org/users/versions'].get

$.paths['/v1/org/users/schema'].get

$.paths['/v1/org/users/list'].post

$.paths['/v1/org/users'].put

$.paths['/v1/sei_contributor/list'].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 Contributors API
  version: 1.0.0
extends: openapi/harness-contributors-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: 5
- target: $.paths['/v1/org/users/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List active contributor data versions
      effect: read
      questions:
      - Which versions of our contributor list are currently active?
      - Can I page through the active contributor data versions?
      instructions:
      - text: List the active versions of our contributor data.
      - text: Show page {page} of active contributor versions.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/users/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the contributor data schema
      effect: read
      questions:
      - What fields, including custom ones, does a contributor record have?
      - Which columns does the contributor schema define?
      instructions:
      - text: Show the contributor data schema with its custom fields.
      - text: Get the field definitions used for contributors.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/users/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List active licensed contributors
      effect: read
      questions:
      - Who counts as an active licensed contributor right now?
      - Can I filter the licensed contributor list for a given data version?
      instructions:
      - text: List the current active licensed contributors.
      - text: Show active licensed contributors from version {version} matching {filter}.
        slots:
          version: query.version
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/users'].put
  update:
    x-apievangelist-phrasing:
      intent: Update existing contributors
      effect: write
      questions:
      - How do I update details for contributors already in the system?
      - Can I bulk-edit existing contributor records?
      instructions:
      - text: Update the existing contributor records.
      - text: Apply my changes to the current contributors.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/sei_contributor/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List SEI contributors for the org
      effect: read
      questions:
      - Which licensed users does Software Engineering Insights count for our organization?
      - Where can I see the SEI contributor list?
      instructions:
      - text: List the SEI contributors for my organization.
      - text: Show licensed users counted by Software Engineering Insights.
      method: generated
      generated: '2026-09-26'