API Evangelist conversational phrasing for Snyk Policies API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk Policies API
  version: 1.0.0
extends: openapi/snyk-policies-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: 10
- target: $.paths['/groups/{group_id}/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's policies
      effect: read
      questions:
      - Which policies are defined at the group level?
      - Can I page through every policy my Snyk group has?
      instructions:
      - text: List the policies for group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show the first {limit} group-level policies in group {group_id}.
        slots:
          limit: query.limit
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a group-level policy
      effect: write
      questions:
      - Can I create a policy that applies across a whole group?
      - Why would creating a group-level policy return a 403?
      instructions:
      - text: Create a new group-level policy in group {group_id}.
        slots:
          group_id: path.group_id
      - text: Add a policy to group {group_id} with these rules.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/policies/{policy_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group-level policy
      effect: destructive
      questions:
      - Can I remove a policy that was set at the group level?
      - What do I need to delete an existing group policy?
      instructions:
      - text: Delete policy {policy_id} from group {group_id}.
        slots:
          policy_id: path.policy_id
          group_id: path.group_id
      - text: Remove group {group_id}'s policy {policy_id}.
        slots:
          group_id: path.group_id
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/policies/{policy_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a group-level policy
      effect: write
      questions:
      - Can I edit an existing group-level policy?
      - Is changing a group policy restricted by a feature flag?
      instructions:
      - text: Update policy {policy_id} in group {group_id}.
        slots:
          policy_id: path.policy_id
          group_id: path.group_id
      - text: Change the rules of group {group_id}'s policy {policy_id}.
        slots:
          group_id: path.group_id
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List or search an organization's ignore policies
      effect: read
      questions:
      - Which ignore policies does my organization have for Code Consistent Ignores?
      - Can I find org policies that expire before a certain date?
      - What org-level policies never expire?
      instructions:
      - text: List the policies for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Search org {org_id} policies for {search}.
        slots:
          org_id: path.org_id
          search: query.search
      - text: List org {org_id} policies expiring before {expires_before}.
        slots:
          org_id: path.org_id
          expires_before: query.expires_before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization-level policy
      effect: write
      questions:
      - Can I create an ignore policy for one organization?
      - What do I need enabled before I can add an org-level policy?
      instructions:
      - text: Create a new policy in organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Add an ignore policy to org {org_id} with these conditions.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/policies/{policy_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one organization policy by ID
      effect: read
      questions:
      - Can I look up a single org-level policy by its ID?
      - What does one org policy's record contain?
      instructions:
      - text: Get policy {policy_id} in organization {org_id}.
        slots:
          policy_id: path.policy_id
          org_id: path.org_id
      - text: Show the details of org {org_id}'s policy {policy_id}.
        slots:
          org_id: path.org_id
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/policies/{policy_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization policy
      effect: destructive
      questions:
      - Can I delete an org-level ignore policy I no longer need?
      - What happens when I remove an organization policy?
      instructions:
      - text: Delete policy {policy_id} from organization {org_id}.
        slots:
          policy_id: path.policy_id
          org_id: path.org_id
      - text: Remove org {org_id}'s policy {policy_id}.
        slots:
          org_id: path.org_id
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/policies/{policy_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an organization policy
      effect: write
      questions:
      - Can I change an existing org-level policy?
      - Is it possible to extend an organization ignore policy after it's created?
      instructions:
      - text: Update policy {policy_id} in organization {org_id}.
        slots:
          policy_id: path.policy_id
          org_id: path.org_id
      - text: Edit the settings of org {org_id}'s policy {policy_id}.
        slots:
          org_id: path.org_id
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/policies/{policy_id}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List the event history of an org policy
      effect: read
      questions:
      - What changes have been made to an org policy over time?
      - Can I see the audit history for an ignore policy in my organization?
      instructions:
      - text: List the events for policy {policy_id} in organization {org_id}.
        slots:
          policy_id: path.policy_id
          org_id: path.org_id
      - text: Show the history of org {org_id} policy {policy_id}.
        slots:
          org_id: path.org_id
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'