Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Findings API

2 actions 2 updates phrasing extends openapi/snyk-findings-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}/tests/{test_id}/findings'].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 Findings API
  version: 1.0.0
extends: openapi/snyk-findings-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}/tests/{test_id}/findings'].get
  update:
    x-apievangelist-phrasing:
      intent: List findings from a test
      effect: read
      questions:
      - What vulnerabilities and policy breaches did my Snyk test find?
      - Can I page through a test's findings regardless of which scanner produced them?
      instructions:
      - text: List findings for test {test_id} in org {org_id}.
        slots:
          test_id: path.test_id
          org_id: path.org_id
      - text: Show the first {limit} findings from test {test_id} for organization {org_id}.
        slots:
          limit: query.limit
          test_id: path.test_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'