Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk OpenAPI API

3 actions 3 updates phrasing extends openapi/snyk-open-api-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 3

$.info

$.paths['/openapi'].get

$.paths['/openapi/{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 OpenAPI API
  version: 1.0.0
extends: openapi/snyk-open-api-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: 2
- target: $.paths['/openapi'].get
  update:
    x-apievangelist-phrasing:
      intent: List available API specification versions
      effect: read
      questions:
      - Which versions of the Snyk REST API OpenAPI specification are available?
      - What version dates can I request the API spec for?
      instructions:
      - text: List the available OpenAPI specification versions.
      - text: Show every published API version I can pin to.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/openapi/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the OpenAPI specification for a version
      effect: read
      questions:
      - Can I download the OpenAPI document that was effective at a given version?
      - Where do I get the spec for a specific API version date?
      instructions:
      - text: Get the OpenAPI specification for version {version}.
        slots:
          version: path.version
      - text: Download the API spec effective at {version}.
        slots:
          version: path.version
      method: generated
      generated: '2026-10-01'