# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk Open Source Settings API
  version: 1.0.0
extends: openapi/snyk-opensourcesettings-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: 9
- target: $.paths['/orgs/{org_id}/settings/opensource'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's Open Source settings
      effect: read
      questions:
      - What Open Source scanning settings apply to my Snyk org?
      - Can I see which open source settings my org inherits from the group?
      instructions:
      - text: Get the Open Source settings for org {org_id}.
        slots:
          org_id: path.org_id
      - text: Show organization {org_id}'s open source scanning configuration.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/settings/opensource/broker'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if the open source broker is on for a group
      effect: read
      questions:
      - Is the open source broker enabled across my group?
      - Can I check a group's open source broker setting?
      instructions:
      - text: Check whether the open source broker is enabled for group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show group {group_id}'s open source broker setting.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/settings/opensource/broker'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable the open source broker for a group
      effect: write
      questions:
      - How do I turn on the open source broker for a whole group?
      - Does enabling the group open source broker install a Snyk App?
      instructions:
      - text: Enable the open source broker for group {group_id}.
        slots:
          group_id: path.group_id
      - text: Switch on group-level open source brokering for {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/settings/opensource/broker'].delete
  update:
    x-apievangelist-phrasing:
      intent: Turn off the open source broker for a group
      effect: destructive
      questions:
      - How do I disable the open source broker for my group?
      - Will removing the group broker setting uninstall its Snyk App?
      instructions:
      - text: Delete the open source broker setting for group {group_id}.
        slots:
          group_id: path.group_id
      - text: Turn off group-level open source brokering for {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/settings/opensource/broker'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if the open source broker is on for an org
      effect: read
      questions:
      - Is the open source broker enabled for this organization?
      - Can I read an org's open source broker flag?
      instructions:
      - text: Check whether the open source broker is enabled for org {org_id}.
        slots:
          org_id: path.org_id
      - text: Show organization {org_id}'s open source broker setting.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/settings/opensource/broker'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable the open source broker for an organization
      effect: write
      questions:
      - How do I turn on the open source broker for just one org?
      - Does enabling an org's open source broker install the Snyk App there?
      instructions:
      - text: Enable the open source broker for org {org_id}.
        slots:
          org_id: path.org_id
      - text: Switch on open source brokering in organization {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/settings/opensource/broker'].delete
  update:
    x-apievangelist-phrasing:
      intent: Turn off the open source broker for an organization
      effect: destructive
      questions:
      - How do I disable the open source broker in a single organization?
      - Can I uninstall the broker app from one org only?
      instructions:
      - text: Delete the open source broker setting for org {org_id}.
        slots:
          org_id: path.org_id
      - text: Turn off open source brokering in organization {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/settings/opensource/{ecosystem}/broker'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an org's broker settings for one ecosystem
      effect: read
      questions:
      - What Broker settings does my org have for npm or Maven packages?
      - Can I see the brokered registries configured per open source ecosystem?
      instructions:
      - text: Get the {ecosystem} broker settings for org {org_id}.
        slots:
          ecosystem: path.ecosystem
          org_id: path.org_id
      - text: Show which Broker integrations org {org_id} uses for the {ecosystem} ecosystem.
        slots:
          org_id: path.org_id
          ecosystem: path.ecosystem
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/settings/opensource/{ecosystem}/broker'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an org's broker settings for one ecosystem
      effect: write
      questions:
      - How do I change which Broker integration serves an ecosystem's packages?
      - Are ecosystem broker updates partial, touching only the integrations I send?
      instructions:
      - text: Update the {ecosystem} broker settings for org {org_id}.
        slots:
          ecosystem: path.ecosystem
          org_id: path.org_id
      - text: Patch org {org_id}'s Broker integrations for the {ecosystem} ecosystem.
        slots:
          org_id: path.org_id
          ecosystem: path.ecosystem
      method: generated
      generated: '2026-09-26'