Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Group API

2 actions 2 updates phrasing extends openapi/snyk-group-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['/groups/{group_id}'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk Group API
  version: 1.0.0
extends: openapi/snyk-group-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['/groups/{group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group's details
      effect: read
      questions:
      - Can I look up the details of a Snyk group by its ID?
      - What information comes back for a single group?
      instructions:
      - text: Get group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show the details of group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'