# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk Issues API
  version: 1.0.0
extends: openapi/snyk-issues-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: 6
- target: $.paths['/groups/{group_id}/issues'].get
  update:
    x-apievangelist-phrasing:
      intent: List security issues across a group
      effect: read
      questions:
      - What open critical vulnerabilities exist across my whole Snyk group?
      - Can I filter group issues by severity, status or whether they're ignored?
      - Which issues across the group were updated this week?
      instructions:
      - text: List issues across group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show {effective_severity_level} severity issues with status {status} in group {group_id}.
        slots:
          effective_severity_level: query.effective_severity_level
          status: query.status
          group_id: path.group_id
      - text: List group {group_id} issues updated after {updated_after}.
        slots:
          group_id: path.group_id
          updated_after: query.updated_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/issues/{issue_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one issue at group level
      effect: read
      questions:
      - Where can I see full details of a vulnerability using my group's scope?
      - Can I fetch a single issue by ID across the group?
      instructions:
      - text: Get issue {issue_id} in group {group_id}.
        slots:
          issue_id: path.issue_id
          group_id: path.group_id
      - text: Show group {group_id}'s record for issue {issue_id}.
        slots:
          group_id: path.group_id
          issue_id: path.issue_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/issues'].get
  update:
    x-apievangelist-phrasing:
      intent: List security issues in an organization
      effect: read
      questions:
      - What vulnerabilities does my organization have open right now?
      - Can I list only one org's issues for a particular project or scan item?
      - Which org issues are ignored?
      instructions:
      - text: List issues in org {org_id}.
        slots:
          org_id: path.org_id
      - text: Show org {org_id} issues for scan item {scan_item_id} of type {scan_item_type}.
        slots:
          org_id: path.org_id
          scan_item_id: query.scan_item.id
          scan_item_type: query.scan_item.type
      - text: List {effective_severity_level} issues in organization {org_id} created after {created_after}.
        slots:
          effective_severity_level: query.effective_severity_level
          org_id: path.org_id
          created_after: query.created_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/issues/{issue_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one issue in an organization
      effect: read
      questions:
      - How do I pull up the details of one vulnerability in my org?
      - Can I look up an org issue by its ID?
      instructions:
      - text: Get issue {issue_id} in org {org_id}.
        slots:
          issue_id: path.issue_id
          org_id: path.org_id
      - text: Show organization {org_id}'s details for issue {issue_id}.
        slots:
          org_id: path.org_id
          issue_id: path.issue_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/packages/issues'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up vulnerabilities for a batch of packages
      effect: read
      questions:
      - Can I check a whole list of package URLs for known vulnerabilities in one request?
      - Does the batch purl lookup include transitive dependency vulnerabilities?
      instructions:
      - text: Check these purls for vulnerabilities in org {org_id}.
        slots:
          org_id: path.org_id
      - text: Batch-query direct vulnerabilities for my package list under organization {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/packages/{purl}/issues'].get
  update:
    x-apievangelist-phrasing:
      intent: List vulnerabilities for one package version
      effect: read
      questions:
      - Is a specific package version known to be vulnerable?
      - What direct vulnerabilities does Snyk report for a single purl?
      instructions:
      - text: List issues for package {purl} in org {org_id}.
        slots:
          purl: path.purl
          org_id: path.org_id
      - text: Check whether {purl} has known vulnerabilities, using org {org_id}.
        slots:
          purl: path.purl
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'