API Evangelist conversational phrasing for Jfrog Evidence API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jfrog Evidence API
  version: 1.0.0
extends: openapi/jfrog-evidence-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/v1/evidence'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach signed evidence to an artifact or build
      effect: write
      questions:
      - How do I attach a signed in-toto attestation to an artifact or build?
      - Can evidence be attached to a package or a release bundle as well as an artifact?
      - What signing key does JFrog use when I create evidence with a key alias?
      instructions:
      - text: Create evidence of type {predicate_type} on {subject_type} {subject}.
        slots:
          predicate_type: requestBody.predicate_type
          subject_type: requestBody.subject_type
          subject: requestBody.subject
      - text: Attach a DSSE-signed attestation to {subject_type} {subject} using key {key_alias}.
        slots:
          subject_type: requestBody.subject_type
          subject: requestBody.subject
          key_alias: requestBody.key_alias
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/evidence/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search evidence records
      effect: read
      questions:
      - Which evidence records were created by a given user in the last month?
      - Can I filter evidence by predicate type and creation date?
      instructions:
      - text: Search evidence of predicate type {predicate_type} created after {created_from}.
        slots:
          predicate_type: requestBody.predicate_type
          created_from: requestBody.created_from
      - text: Find evidence created by {created_by} on {subject_type} subjects.
        slots:
          created_by: requestBody.created_by
          subject_type: requestBody.subject_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/evidence/{evidenceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one evidence record by ID
      effect: read
      questions:
      - How do I see the DSSE envelope of one evidence record by its ID?
      - What verification status does a single evidence record show?
      instructions:
      - text: Show evidence record {evidenceId}.
        slots:
          evidenceId: path.evidenceId
      - text: Get the DSSE envelope for evidence {evidenceId}.
        slots:
          evidenceId: path.evidenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/evidence/{evidenceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an evidence record
      effect: destructive
      questions:
      - How do I remove an evidence record that was attached by mistake?
      - Can I delete a single evidence attestation by its ID?
      instructions:
      - text: Delete evidence record {evidenceId}.
        slots:
          evidenceId: path.evidenceId
      - text: Remove evidence {evidenceId} from the platform.
        slots:
          evidenceId: path.evidenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/evidence/subject/artifact'].get
  update:
    x-apievangelist-phrasing:
      intent: List evidence attached to an artifact
      effect: read
      questions:
      - What attestations are attached to a specific artifact in a repository?
      - Can I look up an artifact's evidence by its SHA-256 checksum?
      instructions:
      - text: List evidence on the artifact at {repo_path}.
        slots:
          repo_path: query.repo_path
      - text: Show evidence for artifact {repo_path} with checksum {sha256}.
        slots:
          repo_path: query.repo_path
          sha256: query.sha256
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/evidence/subject/build'].get
  update:
    x-apievangelist-phrasing:
      intent: List evidence attached to a build
      effect: read
      questions:
      - Which attestations were recorded against a particular build run?
      - Can I scope a build's evidence lookup to one project?
      instructions:
      - text: List evidence for build {build_name} number {build_number}.
        slots:
          build_name: query.build_name
          build_number: query.build_number
      - text: Show build {build_name} run {build_number} evidence in project {project}.
        slots:
          build_name: query.build_name
          build_number: query.build_number
          project: query.project
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/evidence/subject/release-bundle'].get
  update:
    x-apievangelist-phrasing:
      intent: List evidence on a release bundle via v1
      effect: read
      questions:
      - How do I query the v1 evidence subject endpoint for a release bundle version?
      - Can the v1 release-bundle evidence lookup be limited to one project?
      instructions:
      - text: Using the v1 subject lookup, list evidence for release bundle {name} version {version}.
        slots:
          name: query.name
          version: query.version
      - text: Query v1 release-bundle evidence for {name} {version} in project {project}.
        slots:
          name: query.name
          version: query.version
          project: query.project
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/evidence/subject/package'].get
  update:
    x-apievangelist-phrasing:
      intent: List evidence attached to a package
      effect: read
      questions:
      - What evidence is attached to a specific package version in a repository?
      - Can I check attestations on an npm or Maven package version?
      instructions:
      - text: List evidence for package {package_name} version {package_version} in repo {repo_key}.
        slots:
          package_name: query.package_name
          package_version: query.package_version
          repo_key: query.repo_key
      - text: Show attestations on {package_name}@{package_version} stored in {repo_key}.
        slots:
          package_name: query.package_name
          package_version: query.package_version
          repo_key: query.repo_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/evidence'].post
  update:
    x-apievangelist-phrasing:
      intent: Add evidence to a release bundle version (v2)
      effect: write
      questions:
      - How do I record evidence for a release bundle version tied to an environment?
      - Can I point the v2 evidence endpoint at a DSSE file path?
      instructions:
      - text: Add v2 evidence to release bundle {release_bundle_name} version {release_bundle_version} for environment {environment}.
        slots:
          release_bundle_name: requestBody.release_bundle_name
          release_bundle_version: requestBody.release_bundle_version
          environment: requestBody.environment
      - text: Record {evidence_type} evidence on bundle {release_bundle_name} {release_bundle_version} from file {dsse_file_path}.
        slots:
          evidence_type: requestBody.evidence_type
          release_bundle_name: requestBody.release_bundle_name
          release_bundle_version: requestBody.release_bundle_version
          dsse_file_path: requestBody.dsse_file_path
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/evidence/{name}/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get v2 evidence for a release bundle version
      effect: read
      questions:
      - Where do I fetch all v2 evidence for a release bundle by name and version path?
      - Which evidence records does the v2 endpoint return for one bundle version?
      instructions:
      - text: Get v2 evidence for release bundle {name} at version {version}.
        slots:
          name: path.name
          version: path.version
      - text: Fetch the v2 evidence list of bundle {name} {version}.
        slots:
          name: path.name
          version: path.version
      method: generated
      generated: '2026-10-01'