# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Integrations API
  version: 1.0.0
extends: openapi/harness-integrations-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: 8
- target: $.paths['/v1/integrations/{integration}'].get
  update:
    x-apievangelist-phrasing:
      intent: List integrations of a given type
      effect: read
      questions:
      - What integrations of a certain type are set up in my Harness account?
      - Can I search configured integrations by name?
      instructions:
      - text: List all {integration} integrations.
        slots:
          integration: path.integration
      - text: Find {integration} integrations matching {term}.
        slots:
          integration: path.integration
          term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/integrations/{integration}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new integration
      effect: write
      questions:
      - How do I add a new integration of a particular type?
      - Can I dry-run an integration setup to validate it before saving?
      instructions:
      - text: Create a {integration} integration with configuration {config}.
        slots:
          integration: path.integration
          config: requestBody.request
      - text: Dry-run creating a {integration} integration to check the settings.
        slots:
          integration: path.integration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/integrations/{integration}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete integrations of a given type
      effect: destructive
      questions:
      - How do I remove the integrations of a particular type from my account?
      - Can I delete all configured integrations for one integration type?
      instructions:
      - text: Delete the {integration} integrations.
        slots:
          integration: path.integration
      - text: Remove every {integration} integration from my account.
        slots:
          integration: path.integration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/integrations/{integration}/{integration-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one integration's details
      effect: read
      questions:
      - What is configured for a specific integration by its ID?
      - Can I view the settings of one integration?
      instructions:
      - text: Get integration {id} of type {integration}.
        slots:
          id: path.integration-id
          integration: path.integration
      - text: Show the configuration for {integration} integration {id}.
        slots:
          integration: path.integration
          id: path.integration-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/integrations/{integration}/{integration-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an integration's configuration
      effect: write
      questions:
      - How do I change the settings of an existing integration?
      - Can I validate integration changes with a dry run before applying them?
      instructions:
      - text: Update {integration} integration {id} with {config}.
        slots:
          integration: path.integration
          id: path.integration-id
          config: requestBody.request
      - text: Dry-run an update to integration {id} of type {integration}.
        slots:
          id: path.integration-id
          integration: path.integration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/integrations/{integration-id}/discover/entities'].get
  update:
    x-apievangelist-phrasing:
      intent: List entities discovered by an integration
      effect: read
      questions:
      - What catalog entities has an integration discovered so far?
      - Can I search the discovered entities for an integration?
      instructions:
      - text: List discovered entities for integration {id}.
        slots:
          id: path.integration-id
      - text: Search entities discovered by integration {id} for {term}.
        slots:
          id: path.integration-id
          term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/integrations/{integration-id}/discover/entities'].post
  update:
    x-apievangelist-phrasing:
      intent: Import discovered entities from an integration
      effect: write
      questions:
      - How do I save the entities an integration discovered into my catalog?
      - Can I turn on auto-discovery so new entities are imported automatically?
      instructions:
      - text: Save discovered entities {entities} for integration {id}.
        slots:
          entities: requestBody.integration_entities
          id: path.integration-id
      - text: Import entities {entities} from integration {id} and set auto-discover to {auto}.
        slots:
          entities: requestBody.integration_entities
          id: path.integration-id
          auto: requestBody.auto_discover
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/integrations/{integration-id}/entities/unlink'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlink entities from an integration
      effect: write
      questions:
      - How do I detach catalog entities from the integration that imported them?
      - Can I unlink specific entities without deleting the integration?
      instructions:
      - text: Unlink entities {refs} from integration {id}.
        slots:
          refs: requestBody.entity_refs
          id: path.integration-id
      - text: Detach {refs} from integration {id} but keep the integration.
        slots:
          refs: requestBody.entity_refs
          id: path.integration-id
      method: generated
      generated: '2026-09-26'