# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness CICD Workflows API
  version: 1.0.0
extends: openapi/harness-cicdworkflows-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: 6
- target: $.paths['/v1/orgs/{org}/projects/{project}/ci-cd/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List CI/CD workflows in a project
      effect: read
      questions:
      - Which CI/CD workflows has supply chain security discovered in my project?
      - Can I filter the workflow list by CI platform type?
      instructions:
      - text: List the CI/CD workflows in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Search workflows in {project} for {search_term} on platform {platform_type}.
        slots:
          project: path.project
          search_term: requestBody.search_term
          platform_type: requestBody.platform_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/ci-cd/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize CI/CD workflows and compliance
      effect: read
      questions:
      - How many CI/CD workflows do I have and how are they doing on compliance checks?
      - Is there a roll-up of compliance evaluations across all my workflows?
      instructions:
      - text: Summarize the CI/CD workflows in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Give me the workflow count and compliance totals for {project}.
        slots:
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/ci-cd/{workflow}/overview'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an overview of one CI/CD workflow
      effect: read
      questions:
      - What are the overview details of a single CI/CD workflow?
      - Where can I see one workflow's key facts at a glance?
      instructions:
      - text: Show the overview of workflow {workflow} in project {project} of {org}.
        slots:
          workflow: path.workflow
          project: path.project
          org: path.org
      - text: Get overview details for CI/CD workflow {workflow}.
        slots:
          workflow: path.workflow
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/ci-cd/{workflow}/rules/evalution-trend'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow's rule evaluation trend
      effect: read
      questions:
      - How have compliance rule evaluations for a workflow trended over time?
      - Can I see rule results for a CI/CD workflow between two dates?
      instructions:
      - text: Show the rules evaluation trend for workflow {workflow} since {start_time}.
        slots:
          workflow: path.workflow
          start_time: query.start_time
      - text: Chart rule evaluations for {workflow} in {project} of {org} from {start_time} to {end_time}.
        slots:
          workflow: path.workflow
          project: path.project
          org: path.org
          start_time: query.start_time
          end_time: query.end_time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/ci-cd/harness/pipeline/{pipeline-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Harness pipeline's workflow information
      effect: read
      questions:
      - Can I pull the pipeline details for a Harness pipeline tracked as a CI/CD workflow?
      - Where do I read the YAML behind one of my pipelines in the workflow view?
      instructions:
      - text: Get the Harness pipeline information for pipeline {pipeline_id} in project {project} of {org}.
        slots:
          pipeline_id: path.pipeline-id
          project: path.project
          org: path.org
      - text: Show the pipeline YAML for {pipeline_id}.
        slots:
          pipeline_id: path.pipeline-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/ci-cd/{workflow}/plugins'].get
  update:
    x-apievangelist-phrasing:
      intent: List plugins used by a CI/CD workflow
      effect: read
      questions:
      - Which plugins does a given CI/CD workflow use?
      - Can I search the plugin list for one workflow?
      instructions:
      - text: List the plugins for workflow {workflow} in project {project} of {org}.
        slots:
          workflow: path.workflow
          project: path.project
          org: path.org
      - text: Find plugins matching {search_term} in workflow {workflow}.
        slots:
          search_term: query.search_term
          workflow: path.workflow
      method: generated
      generated: '2026-09-26'