# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk SBOM API
  version: 1.0.0
extends: openapi/snyk-sbom-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: 4
- target: $.paths['/orgs/{org_id}/projects/{project_id}/sbom'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project's SBOM document
      effect: read
      questions:
      - Can I download a software bill of materials for one of my Snyk projects?
      - Which SBOM formats are supported, like CycloneDX 1.6 or SPDX 2.3?
      - Is there a way to roll Go packages up to module level in an SBOM?
      instructions:
      - text: Get the SBOM for project {project_id} in org {org_id}.
        slots:
          project_id: path.project_id
          org_id: path.org_id
      - text: Export project {project_id} in org {org_id} as an SBOM in {format} format.
        slots:
          project_id: path.project_id
          org_id: path.org_id
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/sbom_tests'].post
  update:
    x-apievangelist-phrasing:
      intent: Test an SBOM document for vulnerabilities
      effect: write
      questions:
      - Can I upload an SBOM and have its components checked for known vulnerabilities?
      - Why were some components skipped when I tested my SBOM?
      - Which purl types does an SBOM test support?
      instructions:
      - text: Start a vulnerability test of this CycloneDX SBOM in org {org_id}.
        slots:
          org_id: path.org_id
      - text: Submit this SPDX 2.3 JSON document for an SBOM test run in org {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/sbom_tests/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an SBOM test run's status
      effect: read
      questions:
      - Has my SBOM test run finished yet?
      - Can I poll the progress of an SBOM vulnerability test?
      instructions:
      - text: Check the status of SBOM test job {job_id} in org {org_id}.
        slots:
          job_id: path.job_id
          org_id: path.org_id
      - text: Tell me whether SBOM test {job_id} in org {org_id} is done.
        slots:
          job_id: path.job_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/sbom_tests/{job_id}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the findings of an SBOM test run
      effect: read
      questions:
      - What vulnerabilities did my SBOM test find?
      - Can I page through the results of a completed SBOM test?
      instructions:
      - text: Get the results of SBOM test job {job_id} in org {org_id}.
        slots:
          job_id: path.job_id
          org_id: path.org_id
      - text: Show the first {limit} findings from SBOM test {job_id} in org {org_id}.
        slots:
          limit: query.limit
          job_id: path.job_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'