Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Onboarding Resource API

5 actions 5 updates phrasing extends openapi/harness-onboardingresource-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 5

$.info
$.paths['/v1/onboarding/harness-entities'].get
$.paths['/v1/onboarding/harness-entities-count'].get
$.paths['/v1/onboarding/import-harness-entities'].post
$.paths['/v1/onboarding/generate-yaml'].post

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 Harness Onboarding Resource API
  version: 1.0.0
extends: openapi/harness-onboardingresource-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: 4
- target: $.paths['/v1/onboarding/harness-entities'].get
  update:
    x-apievangelist-phrasing:
      intent: List entities available to import into IDP
      effect: read
      questions:
      - Which services and entities from my account can be onboarded into the developer portal catalog?
      - Can I narrow the onboarding entity list to a single project?
      instructions:
      - text: List entities I can onboard into the portal from project {project_to_filter}.
        slots:
          project_to_filter: query.project_to_filter
      - text: Search onboardable entities for {search_term}.
        slots:
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/onboarding/harness-entities-count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count entities available for onboarding
      effect: read
      questions:
      - How many entities are waiting to be onboarded into the portal?
      - What's the total count of importable entities in my account?
      instructions:
      - text: Count the entities available for onboarding.
      - text: Tell me how many entities could be imported into the developer portal.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/onboarding/import-harness-entities'].post
  update:
    x-apievangelist-phrasing:
      intent: Import entities into the developer portal
      effect: write
      questions:
      - How do I bulk-import my existing services into the IDP catalog?
      - Where does the catalog connector come in when importing entities?
      instructions:
      - text: Import entities of type {type} into IDP using catalog connector {catalog_connector_info}.
        slots:
          type: requestBody.type
          catalog_connector_info: requestBody.catalog_connector_info
      - text: Onboard all {type} entities into the developer portal catalog.
        slots:
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/onboarding/generate-yaml'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate catalog YAML for entities
      effect: read
      questions:
      - Can I preview the catalog-info YAML that would be generated for my entities?
      - How do I get YAML definitions for services before importing them?
      instructions:
      - text: Generate YAML definitions for entities {entities}.
        slots:
          entities: requestBody.entities
      - text: 'Produce catalog YAML for these entities: {entities}.'
        slots:
          entities: requestBody.entities
      method: generated
      generated: '2026-09-26'