Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Audit Filters API

6 actions 6 updates phrasing extends openapi/harness-auditfilters-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['/audit/api/auditFilters'].get
$.paths['/audit/api/auditFilters'].put
$.paths['/audit/api/auditFilters'].post
$.paths['/audit/api/auditFilters/{identifier}'].get
$.paths['/audit/api/auditFilters/{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 Audit Filters API
  version: 1.0.0
extends: openapi/harness-auditfilters-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['/audit/api/auditFilters'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved audit log filters
      effect: read
      questions:
      - Which saved audit trail filters do we have?
      - Can I search saved audit filters by name within a project?
      instructions:
      - text: List my saved audit filters.
      - text: Find saved audit filters in project {projectIdentifier} matching {searchTerm}.
        slots:
          projectIdentifier: query.projectIdentifier
          searchTerm: query.searchTerm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audit/api/auditFilters'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a saved audit filter
      effect: write
      questions:
      - How do I change the criteria in a saved audit filter?
      - Can I change who can see a saved audit filter?
      instructions:
      - text: Update audit filter {identifier} named {name} with properties {filterProperties}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          filterProperties: requestBody.filterProperties
      - text: Change the visibility of audit filter {identifier} to {filterVisibility}, keeping name {name} and properties {filterProperties}.
        slots:
          identifier: requestBody.identifier
          filterVisibility: requestBody.filterVisibility
          name: requestBody.name
          filterProperties: requestBody.filterProperties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audit/api/auditFilters'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a new audit log filter
      effect: write
      questions:
      - Can I save an audit trail search as a reusable filter?
      - What does a new audit filter need?
      instructions:
      - text: Create an audit filter {name} with id {identifier} and properties {filterProperties}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          filterProperties: requestBody.filterProperties
      - text: Save audit filter {identifier} called {name} for project {projectIdentifier} using {filterProperties}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          projectIdentifier: requestBody.projectIdentifier
          filterProperties: requestBody.filterProperties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audit/api/auditFilters/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a saved audit filter
      effect: read
      questions:
      - What criteria does a given saved audit filter apply?
      - Can I open one audit filter by its identifier?
      instructions:
      - text: Show audit filter {identifier}.
        slots:
          identifier: path.identifier
      - text: Get saved audit filter {identifier} in org {orgIdentifier}.
        slots:
          identifier: path.identifier
          orgIdentifier: query.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audit/api/auditFilters/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved audit filter
      effect: destructive
      questions:
      - How do I remove a saved audit filter?
      - Does deleting an audit filter affect the audit log itself?
      instructions:
      - text: Delete audit filter {identifier}.
        slots:
          identifier: path.identifier
      - text: Remove saved audit filter {identifier} from project {projectIdentifier}.
        slots:
          identifier: path.identifier
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'