# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk Asset API
  version: 1.0.0
extends: openapi/snyk-asset-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: 11
- target: $.paths['/groups/{group_id}/assets/repository/aliases'].get
  update:
    x-apievangelist-phrasing:
      intent: List repository URL aliases in a group
      effect: read
      questions:
      - Which alternate repository URLs are aliased to assets across my group?
      - Can I filter group repository aliases down to one canonical URL?
      instructions:
      - text: List repository aliases in group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show group {group_id} aliases pointing at repository {url}.
        slots:
          group_id: path.group_id
          url: query.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/assets/repository/aliases'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a repository URL alias at group level
      effect: write
      questions:
      - How do I tell Snyk that two repo URLs in my group are the same repository?
      - Can I link alternate repository URLs to one canonical asset across a group?
      instructions:
      - text: Add a repository alias in group {group_id}.
        slots:
          group_id: path.group_id
      - text: Link these alternate repo URLs to their canonical asset in group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/assets/repository/aliases'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove repository aliases in a group
      effect: destructive
      questions:
      - How do I detach aliased repo URLs from their canonical asset in my group?
      - What happens to a URL after I remove its alias at group level?
      instructions:
      - text: Remove these repository aliases in group {group_id}.
        slots:
          group_id: path.group_id
      - text: Detach aliased URLs from their canonical repository assets across group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/assets/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search a group's assets with filters
      effect: read
      questions:
      - How can I find repositories, images and other assets in my Snyk group?
      - Can I search group assets using filters instead of paging everything?
      instructions:
      - text: Search the assets in group {group_id}.
        slots:
          group_id: path.group_id
      - text: Find assets in group {group_id} matching my filters.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/assets/{asset_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an asset by its ID
      effect: read
      questions:
      - Where can I see everything Snyk knows about one asset?
      - Can I fetch a single asset's attributes by asset ID?
      instructions:
      - text: Get asset {asset_id} in group {group_id}.
        slots:
          asset_id: path.asset_id
          group_id: path.group_id
      - text: Show the details of asset {asset_id} from group {group_id}.
        slots:
          asset_id: path.asset_id
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/assets/{asset_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an asset's attributes
      effect: write
      questions:
      - How do I change attributes on an asset in my group?
      - Can I partially update an asset without resending all of it?
      instructions:
      - text: Update asset {asset_id} in group {group_id}.
        slots:
          asset_id: path.asset_id
          group_id: path.group_id
      - text: Patch the attributes of asset {asset_id} belonging to group {group_id}.
        slots:
          asset_id: path.asset_id
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/assets/{asset_id}/relationships/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List assets related to an asset
      effect: read
      questions:
      - What other assets are connected to this repository or image?
      - Can I filter an asset's related assets by type?
      instructions:
      - text: List assets related to asset {asset_id} in group {group_id}.
        slots:
          asset_id: path.asset_id
          group_id: path.group_id
      - text: Show related assets of type {type} for asset {asset_id} in group {group_id}.
        slots:
          type: query.type
          asset_id: path.asset_id
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{group_id}/assets/{asset_id}/relationships/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List Snyk projects linked to an asset
      effect: read
      questions:
      - Which Snyk projects scan this asset?
      - Can I see the projects tied to a repository asset?
      instructions:
      - text: List projects for asset {asset_id} in group {group_id}.
        slots:
          asset_id: path.asset_id
          group_id: path.group_id
      - text: Show which projects are linked to asset {asset_id} in group {group_id}.
        slots:
          asset_id: path.asset_id
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/assets/repository/aliases'].get
  update:
    x-apievangelist-phrasing:
      intent: List repository URL aliases in an organization
      effect: read
      questions:
      - Which repository URL aliases exist in my organization?
      - Can I narrow an org's repo aliases to a single canonical URL?
      instructions:
      - text: List repository aliases in org {org_id}.
        slots:
          org_id: path.org_id
      - text: Show org {org_id} aliases for repository {url}.
        slots:
          org_id: path.org_id
          url: query.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/assets/repository/aliases'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a repository URL alias in an organization
      effect: write
      questions:
      - How do I merge two repo URLs into one asset within a single organization?
      - Can I add an alternate URL to a repository asset at org level?
      instructions:
      - text: Add a repository alias in org {org_id}.
        slots:
          org_id: path.org_id
      - text: Link alternate repo URLs to their canonical asset in organization {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/assets/repository/aliases'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove repository aliases in an organization
      effect: destructive
      questions:
      - How do I split aliased repo URLs back out in one organization?
      - Does removing an org alias create a standalone asset for that URL?
      instructions:
      - text: Remove these repository aliases in org {org_id}.
        slots:
          org_id: path.org_id
      - text: Detach aliased URLs from canonical repository assets in organization {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'