API Evangelist conversational phrasing for Image catalog service Imagecatalog API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Image catalog service Imagecatalog API
  version: 1.0.0
extends: openapi/cloudera-imagecatalog-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 11
- target: $.paths['/api/v1/imagecatalog/createCustomCatalog'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom image catalog
      effect: write
      questions:
      - How do I set up my own image catalog for Cloudera Runtime and FreeIPA images?
      - Can I add a description when I create a new custom image catalog?
      instructions:
      - text: Create a custom image catalog named {catalogName}.
        slots:
          catalogName: requestBody.catalogName
      - text: Create image catalog {catalogName} with the description {description}.
        slots:
          catalogName: requestBody.catalogName
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/imagecatalog/deleteCustomCatalog'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom image catalog
      effect: destructive
      questions:
      - Can I remove a custom image catalog I no longer use?
      - What happens to an entire custom image catalog when I delete it?
      instructions:
      - text: Delete the custom image catalog {catalogName}.
        slots:
          catalogName: requestBody.catalogName
      - text: Remove image catalog {catalogName} entirely.
        slots:
          catalogName: requestBody.catalogName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/imagecatalog/deleteFreeipaImage'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a FreeIPA image from a catalog
      effect: destructive
      questions:
      - How do I take a FreeIPA image out of one of my custom catalogs?
      - Can I delete a single FreeIPA image without deleting the whole catalog?
      instructions:
      - text: Delete FreeIPA image {imageId} from catalog {catalogName}.
        slots:
          imageId: requestBody.imageId
          catalogName: requestBody.catalogName
      - text: Remove the FreeIPA image {imageId} from my {catalogName} image catalog.
        slots:
          imageId: requestBody.imageId
          catalogName: requestBody.catalogName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/imagecatalog/deleteRuntimeImage'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a Cloudera Runtime image from a catalog
      effect: destructive
      questions:
      - Can I remove an outdated Cloudera Runtime image from my custom catalog?
      - Which details do I need to delete a Runtime image from a catalog?
      instructions:
      - text: Delete Cloudera Runtime image {imageId} from catalog {catalogName}.
        slots:
          imageId: requestBody.imageId
          catalogName: requestBody.catalogName
      - text: Remove the Runtime image {imageId} from the {catalogName} catalog.
        slots:
          imageId: requestBody.imageId
          catalogName: requestBody.catalogName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/imagecatalog/describeCustomCatalog'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of a custom image catalog
      effect: read
      questions:
      - What images and settings does my custom image catalog contain?
      - Can I look up the details of one specific custom image catalog by name?
      instructions:
      - text: Describe the custom image catalog {catalogName}.
        slots:
          catalogName: requestBody.catalogName
      - text: Show me what is in image catalog {catalogName}.
        slots:
          catalogName: requestBody.catalogName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/imagecatalog/describeCustomImage'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of an image in a custom catalog
      effect: read
      questions:
      - What do I know about a specific image stored in my custom catalog?
      - Can I inspect one image inside a custom image catalog by its id?
      instructions:
      - text: Describe image {imageId} in custom catalog {catalogName}.
        slots:
          imageId: requestBody.imageId
          catalogName: requestBody.catalogName
      - text: Show the details of image {imageId} from my {catalogName} catalog.
        slots:
          imageId: requestBody.imageId
          catalogName: requestBody.catalogName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/imagecatalog/describeDefaultImage'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an image from the default catalog by id
      effect: read
      questions:
      - How do I look up an image in Cloudera's default catalog when I already know its id?
      - Can I fetch a default-catalog image directly without naming a catalog?
      instructions:
      - text: Describe default catalog image {imageId}.
        slots:
          imageId: requestBody.imageId
      - text: Get image {imageId} straight from the default image catalog.
        slots:
          imageId: requestBody.imageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/imagecatalog/findDefaultImage'].post
  update:
    x-apievangelist-phrasing:
      intent: Find a default image by provider and type
      effect: read
      questions:
      - Which default image should I use for a given cloud provider and image type?
      - Can I filter the default catalog by runtime version or CPU architecture to find an image?
      instructions:
      - text: Find the default {imageType} image for cloud provider {provider}.
        slots:
          imageType: requestBody.imageType
          provider: requestBody.provider
      - text: Find a default {imageType} image on {provider} for runtime {runtimeVersion} and {architecture} architecture.
        slots:
          imageType: requestBody.imageType
          provider: requestBody.provider
          runtimeVersion: requestBody.runtimeVersion
          architecture: requestBody.architecture
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/imagecatalog/listCustomCatalogs'].post
  update:
    x-apievangelist-phrasing:
      intent: List custom image catalogs
      effect: read
      questions:
      - Which custom image catalogs can I access?
      - What Runtime and FreeIPA image catalogs exist in my account?
      instructions:
      - text: List all my custom image catalogs.
      - text: Show every Runtime and FreeIPA image catalog I have access to.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/imagecatalog/setFreeipaImage'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or update a FreeIPA image in a catalog
      effect: write
      questions:
      - How do I add a FreeIPA image to my custom catalog?
      - Can I update an existing FreeIPA image entry with new VM images?
      instructions:
      - text: Add FreeIPA image based on {sourceImageId} with VM images {vmImages} to catalog {catalogName}.
        slots:
          sourceImageId: requestBody.sourceImageId
          vmImages: requestBody.vmImages
          catalogName: requestBody.catalogName
      - text: Update FreeIPA image {imageId} in catalog {catalogName} from source {sourceImageId} using VM images {vmImages}.
        slots:
          imageId: requestBody.imageId
          catalogName: requestBody.catalogName
          sourceImageId: requestBody.sourceImageId
          vmImages: requestBody.vmImages
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/imagecatalog/setRuntimeImage'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or update a Cloudera Runtime image
      effect: write
      questions:
      - Can I add a Cloudera Runtime image to my own catalog?
      - Is it possible to point a Runtime image at a different base parcel URL?
      instructions:
      - text: Add a Cloudera Runtime image from source {sourceImageId} with VM images {vmImages} to catalog {catalogName}.
        slots:
          sourceImageId: requestBody.sourceImageId
          vmImages: requestBody.vmImages
          catalogName: requestBody.catalogName
      - text: Update Runtime image {imageId} in {catalogName} from {sourceImageId} with VM images {vmImages} and base parcel URL {baseParcelUrl}.
        slots:
          imageId: requestBody.imageId
          catalogName: requestBody.catalogName
          sourceImageId: requestBody.sourceImageId
          vmImages: requestBody.vmImages
          baseParcelUrl: requestBody.baseParcelUrl
      method: generated
      generated: '2026-10-01'