Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Package API

2 actions 2 updates phrasing extends openapi/snyk-package-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}'].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 API
  version: 1.0.0
extends: openapi/snyk-package-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}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a package's metadata and health
      effect: read
      questions:
      - How healthy is an open source package before I add it as a dependency?
      - Does a package's security health score cover all versions or only the latest?
      instructions:
      - text: Get package {package_name} from the {ecosystem} ecosystem using org {org_id}.
        slots:
          package_name: path.package_name
          ecosystem: path.ecosystem
          org_id: path.org_id
      - text: Show the package health of {ecosystem} package {package_name} for organization {org_id}.
        slots:
          ecosystem: path.ecosystem
          package_name: path.package_name
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'