# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk Export API
  version: 1.0.0
extends: openapi/snyk-export-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}/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a data export for a group
      effect: write
      questions:
      - Can I export report data for my whole Snyk group?
      - Is it possible to include deleted or deactivated records in a group export?
      instructions:
      - text: Start an export for group {group_id}.
        slots:
          group_id: path.group_id
      - text: Start a group {group_id} export with include_deleted set to {include_deleted}.
        slots:
          group_id: path.group_id
          include_deleted: query.include_deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/export/{export_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of a group export
      effect: read
      questions:
      - Where do I download the results of a finished group export?
      - What does a completed group-level export return?
      instructions:
      - text: Get the results of export {export_id} for group {group_id}.
        slots:
          export_id: path.export_id
          group_id: path.group_id
      - text: Fetch group {group_id}'s export {export_id} output.
        slots:
          group_id: path.group_id
          export_id: path.export_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/jobs/export/{export_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a group export job's status
      effect: read
      questions:
      - Is my group export finished yet?
      - Can I poll the job status of a group-level export?
      instructions:
      - text: Check the status of export job {export_id} for group {group_id}.
        slots:
          export_id: path.export_id
          group_id: path.group_id
      - text: Tell me whether group {group_id} export {export_id} has completed.
        slots:
          group_id: path.group_id
          export_id: path.export_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a data export for an organization
      effect: write
      questions:
      - Can I export report data for a single organization?
      - Is there an option to include deactivated records in an org export?
      instructions:
      - text: Start an export for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Start an org {org_id} export with include_deactivated set to {include_deactivated}.
        slots:
          org_id: path.org_id
          include_deactivated: query.include_deactivated
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/export/{export_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of an organization export
      effect: read
      questions:
      - Where do I get the output of an org export once it's done?
      - What comes back from a completed organization export?
      instructions:
      - text: Get the results of export {export_id} for organization {org_id}.
        slots:
          export_id: path.export_id
          org_id: path.org_id
      - text: Fetch org {org_id}'s export {export_id} output.
        slots:
          org_id: path.org_id
          export_id: path.export_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/jobs/export/{export_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an organization export job's status
      effect: read
      questions:
      - Has my organization export finished running?
      - Can I poll an org-level export job until it's ready?
      instructions:
      - text: Check the status of export job {export_id} for organization {org_id}.
        slots:
          export_id: path.export_id
          org_id: path.org_id
      - text: Tell me whether org {org_id} export {export_id} has completed.
        slots:
          org_id: path.org_id
          export_id: path.export_id
      method: generated
      generated: '2026-09-26'