# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Registry V3 - Files API
  version: 1.0.0
extends: openapi/harness-registry-v3-files-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['/har/api/v3/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List files across artifact registries
      effect: read
      questions:
      - Which files belong to a given package version in my artifact registry?
      - Can I narrow a registry file listing to one package or search term?
      instructions:
      - text: List files for version {version_id} of package {package_id}.
        slots:
          version_id: query.version_id
          package_id: query.package_id
      - text: Show registry files in {registry_id} matching {search_term}.
        slots:
          registry_id: query.registry_id
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/files/{id}/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a registry file by id
      effect: read
      questions:
      - How do I download the bytes of a registry file when I know its id?
      - Can I get a redirect to an inline preview instead of the raw file?
      instructions:
      - text: Download registry file {id}.
        slots:
          id: path.id
      - text: Open file {id} with preview set to {preview} so it redirects to the inline view.
        slots:
          id: path.id
          preview: query.preview
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/files/{id}/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metadata for a registry file
      effect: read
      questions:
      - What metadata is attached to a single file in my registry?
      - Where can I read the key-value metadata on one artifact file?
      instructions:
      - text: Show the metadata of file {id}.
        slots:
          id: path.id
      - text: Get all key-value metadata stored on registry file {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/files/{id}/metadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all metadata on a registry file
      effect: write
      questions:
      - How do I overwrite every metadata entry on a file so only new ones remain?
      - Can I reset a file's metadata to an entirely new set?
      instructions:
      - text: Replace all metadata on file {id} with {metadata}.
        slots:
          id: path.id
          metadata: requestBody.metadata
      - text: Reset the metadata of registry file {id} to exactly {metadata}, dropping old keys.
        slots:
          id: path.id
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/files/{id}/metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or overwrite metadata keys on a registry file
      effect: write
      questions:
      - Can I add a metadata key to a file without erasing its other metadata?
      - What's the way to upsert a few metadata values on one registry file?
      instructions:
      - text: Upsert metadata {metadata} on file {id}.
        slots:
          metadata: requestBody.metadata
          id: path.id
      - text: Add or overwrite keys {metadata} on registry file {id}, keeping the rest.
        slots:
          metadata: requestBody.metadata
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/files/{id}/preview'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an inline preview URL for a registry file
      effect: read
      questions:
      - How do I get a browser-viewable link to preview a registry file?
      - Does the preview link for a file expire?
      instructions:
      - text: Get an inline preview URL for file {id}.
        slots:
          id: path.id
      - text: Give me a presigned link to view registry file {id} in the browser.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/files/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search registry files by path regex
      effect: read
      questions:
      - Can I find files in a registry using a regular expression on their path?
      - How do I search for every file whose path ends in a given extension across a registry?
      instructions:
      - text: Search registry {registry} for files whose path matches regex {regex}.
        slots:
          registry: requestBody.registry
          regex: requestBody.regex
      - text: Find all files in {registry} matching the POSIX pattern {regex}, sorted by {sort}.
        slots:
          registry: requestBody.registry
          regex: requestBody.regex
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/internal/registries/{registry_name}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List files in a named registry
      effect: read
      questions:
      - What files are stored in one registry I can name?
      - Can I list a registry's files filtered to a package name and version?
      instructions:
      - text: List the files in registry {registry_name}.
        slots:
          registry_name: path.registry_name
      - text: Show files in registry {registry_name} for package {package_name} version {version}.
        slots:
          registry_name: path.registry_name
          package_name: query.package_name
          version: query.version
      method: generated
      generated: '2026-09-26'