# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk Integrations API
  version: 1.0.0
extends: openapi/snyk-integrations-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: 7
- target: $.paths['/orgs/{org_id}/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's integrations
      effect: read
      questions:
      - Which integrations are set up in my Snyk organization?
      - Can I page through all of an org's integrations?
      instructions:
      - text: List the integrations in org {org_id}.
        slots:
          org_id: path.org_id
      - text: Show the first {limit} integrations for organization {org_id}.
        slots:
          limit: query.limit
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an integration with credentials
      effect: write
      questions:
      - How do I add a new integration with credentials to my org?
      - Can I give an integration a custom profile name when creating it?
      instructions:
      - text: Create a new integration in org {org_id}.
        slots:
          org_id: path.org_id
      - text: Add an integration with these credentials and profile name to organization {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/integrations/{integration_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single integration
      effect: read
      questions:
      - Where can I see the details of one integration?
      - Can I look up an integration by its ID?
      instructions:
      - text: Get integration {integration_id} in org {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      - text: Show details for integration {integration_id} of organization {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/integrations/{integration_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a container registry integration
      effect: destructive
      questions:
      - How do I permanently remove a container registry integration?
      - Do I need to turn off broker mode before deleting a brokered integration?
      instructions:
      - text: Delete integration {integration_id} from org {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      - text: Hard-delete the container registry integration {integration_id} in organization {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/integrations/{integration_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an integration's name or credentials
      effect: write
      questions:
      - How do I rotate the credentials on an existing integration?
      - Can I change an integration's profile name without touching anything else?
      instructions:
      - text: Update integration {integration_id} in org {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      - text: Rename the profile of integration {integration_id} for organization {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/integrations/{integration_id}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration's settings
      effect: read
      questions:
      - What settings are configured on one of my integrations?
      - Is container application scanning turned on for this integration?
      instructions:
      - text: Get the settings of integration {integration_id} in org {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      - text: Show integration {integration_id}'s configuration options for organization {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/integrations/{integration_id}/settings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an integration's settings
      effect: write
      questions:
      - How do I enable container application scanning on an integration?
      - Can I change just one integration setting and leave the rest?
      instructions:
      - text: Update the settings of integration {integration_id} in org {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      - text: Turn on container app scanning for integration {integration_id} in organization {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'