Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Iac Settings API

5 actions 5 updates phrasing extends openapi/snyk-iacsettings-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 5

$.info
$.paths['/groups/{group_id}/settings/iac'].get
$.paths['/groups/{group_id}/settings/iac'].patch
$.paths['/orgs/{org_id}/settings/iac'].get
$.paths['/orgs/{org_id}/settings/iac'].patch

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 Iac Settings API
  version: 1.0.0
extends: openapi/snyk-iacsettings-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: 4
- target: $.paths['/groups/{group_id}/settings/iac'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group's Infrastructure as Code settings
      effect: read
      questions:
      - What Infrastructure as Code settings are applied across my Snyk group?
      - Can I check a group's IaC scanning configuration?
      instructions:
      - text: Get the IaC settings for group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show group {group_id}'s Infrastructure as Code configuration.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/settings/iac'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a group's Infrastructure as Code settings
      effect: write
      questions:
      - Can I change IaC settings for every org in a group at once?
      - Where do I edit group-level Infrastructure as Code configuration?
      instructions:
      - text: Update the IaC settings for group {group_id}.
        slots:
          group_id: path.group_id
      - text: Change group {group_id}'s Infrastructure as Code configuration with these values.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/settings/iac'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an org's Infrastructure as Code settings
      effect: read
      questions:
      - What Infrastructure as Code settings does one organization use?
      - Can I view an org's IaC configuration to see if it differs from the group?
      instructions:
      - text: Get the IaC settings for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Show org {org_id}'s Infrastructure as Code configuration.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/settings/iac'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an org's Infrastructure as Code settings
      effect: write
      questions:
      - Can I change the IaC settings for a single organization?
      - Where do I edit an org's Infrastructure as Code configuration?
      instructions:
      - text: Update the IaC settings for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Change org {org_id}'s Infrastructure as Code configuration with these values.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'