# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk Custom Base Images API
  version: 1.0.0
extends: openapi/snyk-custom-base-images-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: 5
- target: $.paths['/custom_base_images'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom base images
      effect: read
      questions:
      - Which custom base images are registered for my org or group?
      - Can I filter custom base images by repository and tag?
      - Which custom base images are included in upgrade recommendations?
      instructions:
      - text: List custom base images for org {org_id}.
        slots:
          org_id: query.org_id
      - text: Show custom base images in group {group_id} for repository {repository}.
        slots:
          group_id: query.group_id
          repository: query.repository
      - text: List custom base images for repository {repository} sorted by {sort_by} {sort_direction} in org {org_id}.
        slots:
          repository: query.repository
          sort_by: query.sort_by
          sort_direction: query.sort_direction
          org_id: query.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_base_images'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a container project as a custom base image
      effect: write
      questions:
      - How do I register my own base image so Snyk recommends upgrades to it?
      - Do I have to import the image into Snyk before marking it as a custom base image?
      instructions:
      - text: Mark imported container project {project} as a custom base image.
        slots:
          project: requestBody.data
      - text: Register our golden image project as a custom base image for recommendations.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_base_images/{custombaseimage_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom base image
      effect: read
      questions:
      - Where can I see one custom base image's settings?
      - Can I fetch a custom base image by ID?
      instructions:
      - text: Get custom base image {custombaseimage_id}.
        slots:
          custombaseimage_id: path.custombaseimage_id
      - text: Show the details of custom base image {custombaseimage_id}.
        slots:
          custombaseimage_id: path.custombaseimage_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_base_images/{custombaseimage_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom base image
      effect: destructive
      questions:
      - How do I stop treating an image as a custom base image?
      - Does deleting a custom base image also delete its container project?
      instructions:
      - text: Delete custom base image {custombaseimage_id}.
        slots:
          custombaseimage_id: path.custombaseimage_id
      - text: Unregister {custombaseimage_id} as a custom base image, keeping its project.
        slots:
          custombaseimage_id: path.custombaseimage_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_base_images/{custombaseimage_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom base image
      effect: write
      questions:
      - How do I exclude a custom base image from recommendations?
      - Can I change a custom base image's attributes after registering it?
      instructions:
      - text: Update custom base image {custombaseimage_id}.
        slots:
          custombaseimage_id: path.custombaseimage_id
      - text: Stop recommending custom base image {custombaseimage_id} as an upgrade target.
        slots:
          custombaseimage_id: path.custombaseimage_id
      method: generated
      generated: '2026-09-26'