Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Sast Settings API

3 actions 3 updates phrasing extends openapi/snyk-sastsettings-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['/orgs/{org_id}/settings/sast'].get
$.paths['/orgs/{org_id}/settings/sast'].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 Sast Settings API
  version: 1.0.0
extends: openapi/snyk-sastsettings-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: 2
- target: $.paths['/orgs/{org_id}/settings/sast'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an org's SAST settings
      effect: read
      questions:
      - Is Snyk Code static analysis turned on for my organization?
      - Can I read an org's SAST settings through the API?
      instructions:
      - text: Get the SAST settings for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Check whether code analysis is enabled in org {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/settings/sast'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable Snyk Code for an org
      effect: write
      questions:
      - Can I switch Snyk Code on for an organization programmatically?
      - What turns off static code analysis for one org?
      instructions:
      - text: Enable Snyk Code for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Disable SAST scanning in org {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'