Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Languages Settings API

3 actions 3 updates phrasing extends openapi/snyk-languagessettings-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/open_source/languages'].get

$.paths['/orgs/{org_id}/settings/open_source/languages/{language}'].patch

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 Languages Settings API
  version: 1.0.0
extends: openapi/snyk-languagessettings-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/open_source/languages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an org's open source language settings
      effect: read
      questions:
      - What open source language settings are configured for my organization?
      - Can I see the per-language scanning settings for one org?
      instructions:
      - text: Get the language settings for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Show org {org_id}'s open source language configuration.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/settings/open_source/languages/{language}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one language's settings for an org
      effect: write
      questions:
      - Can I change the open source settings for a single language in my org?
      - Where do I adjust how one language is handled for an organization?
      instructions:
      - text: Update the {language} language settings for organization {org_id}.
        slots:
          language: path.language
          org_id: path.org_id
      - text: Change org {org_id}'s open source settings for {language}.
        slots:
          org_id: path.org_id
          language: path.language
      method: generated
      generated: '2026-09-26'