Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Filters API

6 actions 6 updates phrasing extends openapi/harness-filters-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['/gitops/api/filters'].get
$.paths['/gitops/api/filters'].put
$.paths['/gitops/api/filters'].post
$.paths['/gitops/api/filters/{identifier}'].get
$.paths['/gitops/api/filters/{identifier}'].delete

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 Filters API
  version: 1.0.0
extends: openapi/harness-filters-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['/gitops/api/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved GitOps filters
      effect: read
      questions:
      - Which saved filters do I have in GitOps?
      - Can I search GitOps filters by name and filter type?
      instructions:
      - text: List GitOps filters of type {type}.
        slots:
          type: query.filterType
      - text: Search GitOps filters for {term}.
        slots:
          term: query.searchTerm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/filters'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a saved GitOps filter
      effect: write
      questions:
      - How do I change the conditions of a saved GitOps filter?
      - Can I change a GitOps filter's visibility?
      instructions:
      - text: Update GitOps filter {identifier} with properties {properties}.
        slots:
          identifier: requestBody.identifier
          properties: requestBody.filterProperties
      - text: Set the visibility of GitOps filter {identifier} to {visibility}.
        slots:
          identifier: requestBody.identifier
          visibility: requestBody.filterVisibility
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/filters'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a new GitOps filter
      effect: write
      questions:
      - Can I save a filter for my GitOps applications view?
      - What's needed to create a GitOps filter?
      instructions:
      - text: Create GitOps filter {name} with identifier {identifier} and properties {properties}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          properties: requestBody.filterProperties
      - text: Save a GitOps filter {name} of type {type}.
        slots:
          name: requestBody.name
          type: requestBody.filterType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/filters/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a saved GitOps filter
      effect: read
      questions:
      - What criteria does one of my GitOps filters hold?
      - Can I fetch a GitOps filter by its identifier?
      instructions:
      - text: Get GitOps filter {identifier}.
        slots:
          identifier: path.identifier
      - text: Show GitOps filter {identifier} of type {type}.
        slots:
          identifier: path.identifier
          type: query.filterType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/filters/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved GitOps filter
      effect: destructive
      questions:
      - How do I remove a GitOps filter I don't use?
      - Can I delete a saved GitOps filter by identifier?
      instructions:
      - text: Delete GitOps filter {identifier}.
        slots:
          identifier: path.identifier
      - text: Remove GitOps filter {identifier} of type {type}.
        slots:
          identifier: path.identifier
          type: query.filterType
      method: generated
      generated: '2026-09-26'