Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Package Version API

2 actions 2 updates phrasing extends openapi/snyk-package-version-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Snyk's API. It is a proposal applied on top of the contract, not a document Snyk publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/orgs/{org_id}/ecosystems/{ecosystem}/packages/{package_name}/versions/{package_version}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk Package Version API
  version: 1.0.0
extends: openapi/snyk-package-version-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: 1
- target: $.paths['/orgs/{org_id}/ecosystems/{ecosystem}/packages/{package_name}/versions/{package_version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get health metadata for a package version
      effect: read
      questions:
      - Is a specific version of an npm or PyPI package healthy and secure?
      - Does the package health security rating reflect the version I ask about or the latest release?
      - Can I look up a Go module version by commit hash?
      instructions:
      - text: Get metadata for {package_name} version {package_version} in the {ecosystem} ecosystem using org {org_id}.
        slots:
          package_name: path.package_name
          package_version: path.package_version
          ecosystem: path.ecosystem
          org_id: path.org_id
      - text: Show the package health rating of {ecosystem} package {package_name}@{package_version} for org {org_id}.
        slots:
          ecosystem: path.ecosystem
          package_name: path.package_name
          package_version: path.package_version
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'