# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Artifact Listing API
  version: 1.0.0
extends: openapi/harness-artifactlisting-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: 7
- target: $.paths['/v1/orgs/{org}/projects/{project}/artifact-sources'].post
  update:
    x-apievangelist-phrasing:
      intent: List artifact sources with artifact counts
      effect: read
      questions:
      - Which artifact registries feed my project and how many artifacts does each hold?
      - Can I filter artifact sources by license or policy violations?
      instructions:
      - text: List artifact sources in org {org}, project {project}.
        slots:
          org: path.org
          project: path.project
      - text: Show artifact sources in {org}/{project} matching {search}.
        slots:
          org: path.org
          project: path.project
          search: requestBody.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/artifact-sources/{source}/artifacts'].post
  update:
    x-apievangelist-phrasing:
      intent: List artifacts from one artifact source
      effect: read
      questions:
      - What artifacts come from a particular registry source?
      - Can I find artifacts in a source that have policy violations?
      instructions:
      - text: List artifacts from source {source} in {org}/{project}.
        slots:
          source: path.source
          org: path.org
          project: path.project
      - text: Show artifacts in source {source} of {org}/{project} deployed to {env_type} environments.
        slots:
          source: path.source
          org: path.org
          project: path.project
          env_type: requestBody.environment_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/artifacts/{artifact}/components'].post
  update:
    x-apievangelist-phrasing:
      intent: List the SBOM components of an artifact
      effect: read
      questions:
      - Which open source components and licenses are inside an artifact?
      - Can I filter an artifact's components by package manager or image layer?
      instructions:
      - text: List components of artifact {artifact} in {org}/{project}.
        slots:
          artifact: path.artifact
          org: path.org
          project: path.project
      - text: Show {package_manager} components in artifact {artifact} ({org}/{project}).
        slots:
          package_manager: requestBody.package_manager
          artifact: path.artifact
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/artifacts/{artifact}/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: See where an artifact is deployed
      effect: read
      questions:
      - Which environments is this artifact deployed to right now?
      - Are any deployments of an artifact violating policy?
      instructions:
      - text: Show deployments of artifact {artifact} in {org}/{project}.
        slots:
          artifact: path.artifact
          org: path.org
          project: path.project
      - text: List where artifact {artifact} runs in environment {environment} for {org}/{project}.
        slots:
          artifact: path.artifact
          environment: requestBody.environment
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/artifact-sources/{source}/artifacts/{artifact}/overview'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an artifact's overview by source and artifact ID
      effect: read
      questions:
      - What is the security and compliance overview of an artifact?
      - Can I get an artifact summary when I know its source and artifact ID?
      instructions:
      - text: Get the overview of artifact {artifact} from source {source} in {org}/{project}.
        slots:
          artifact: path.artifact
          source: path.source
          org: path.org
          project: path.project
      - text: Summarize artifact {artifact} of source {source} for project {project} in org {org}.
        slots:
          artifact: path.artifact
          source: path.source
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/artifact-overview'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an artifact overview by image name and digest
      effect: read
      questions:
      - Can I find an artifact's overview using its image name, registry URL and digest?
      - I only have a container image digest - how do I get its artifact summary?
      instructions:
      - text: Get the overview of image {image} with digest {digest} from registry {registry} in {org}/{project}.
        slots:
          image: query.image_name
          digest: query.digest
          registry: query.registry_url
          org: path.org
          project: path.project
      - text: Look up artifact by name {image} at {registry}, digest {digest}, project {project} in org {org}.
        slots:
          image: query.image_name
          registry: query.registry_url
          digest: query.digest
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/artifacts/{artifact}/chain-of-custody'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an artifact's chain of custody
      effect: read
      questions:
      - What is the full history of events for an artifact from build to deploy?
      - Can I trace the chain of custody of a container image?
      instructions:
      - text: Show the chain of custody for artifact {artifact} in {org}/{project}.
        slots:
          artifact: path.artifact
          org: path.org
          project: path.project
      - text: Trace every custody event of artifact {artifact} in project {project} under org {org}.
        slots:
          artifact: path.artifact
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'