Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Pull Request Templates API

4 actions 4 updates phrasing extends openapi/snyk-pull-request-templates-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 4

$.info

$.paths['/groups/{group_id}/settings/pull_request_template'].get

$.paths['/groups/{group_id}/settings/pull_request_template'].post

$.paths['/groups/{group_id}/settings/pull_request_template'].delete

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 Pull Request Templates API
  version: 1.0.0
extends: openapi/snyk-pull-request-templates-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: 3
- target: $.paths['/groups/{group_id}/settings/pull_request_template'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group's pull request template
      effect: read
      questions:
      - What template does Snyk use for fix pull requests in my group?
      - Can I see the current group-level PR template?
      instructions:
      - text: Get the pull request template for group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show the fix PR template configured on group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/settings/pull_request_template'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a group's pull request template
      effect: write
      questions:
      - How do I customize the title and description of Snyk fix PRs for every org in my group?
      - Can one PR template apply to all projects under a group?
      instructions:
      - text: Set the pull request template for group {group_id}.
        slots:
          group_id: path.group_id
      - text: Create or replace the fix PR template used across group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/settings/pull_request_template'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group's pull request template
      effect: destructive
      questions:
      - How do I go back to Snyk's default pull request template?
      - What happens to fix PRs if I delete the group template?
      instructions:
      - text: Delete the pull request template for group {group_id}.
        slots:
          group_id: path.group_id
      - text: Revert group {group_id} to the default fix PR template.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'