# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Brand Category Images API
  version: 1.0.0
extends: openapi/optimizely-brand-category-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: 10
- target: $.paths['/api/v1/admin/BrandCategoryImages'].get
  update:
    x-apievangelist-phrasing:
      intent: List brand category images
      effect: read
      questions:
      - Which images are set up for our brand category pages?
      - Can I filter brand category images by brand or website?
      - How many brand category images are there in total?
      instructions:
      - text: List all brand category images.
      - text: List brand category images matching {filter}.
        slots:
          filter: query.$filter
      - text: Show {top} brand category images, skipping the first {skip}.
        slots:
          top: query.$top
          skip: query.$skip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BrandCategoryImages'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an image for a brand category
      effect: write
      questions:
      - How do I set a manual image for a brand's category page?
      - Can a brand category image come from a product dynamically instead of a fixed file?
      instructions:
      - text: Add image {manualImagePath} with alt text {manualImageAltText} for brand {brandId} in category {categoryId}, source {imageSource}.
        slots:
          manualImagePath: requestBody.manualImagePath
          manualImageAltText: requestBody.manualImageAltText
          brandId: requestBody.brandId
          categoryId: requestBody.categoryId
          imageSource: requestBody.imageSource
      - text: Create a new brand category image record on website {websiteId}.
        slots:
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BrandCategoryImages({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand category image by id
      effect: read
      questions:
      - What image path and alt text are stored on a particular brand category image?
      - Can I fetch one brand category image record by its id?
      instructions:
      - text: Get brand category image {id}.
        slots:
          id: path.id
      - text: Show the alt text and paths for brand category image {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BrandCategoryImages({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a brand category image record
      effect: write
      questions:
      - Can I overwrite every setting of a brand category image in one request?
      - Will a full replace of a brand category image clear fields I omit?
      instructions:
      - text: Replace brand category image {id} with source {imageSource}, manual path {manualImagePath} and alt text {manualImageAltText}.
        slots:
          id: path.id
          imageSource: requestBody.imageSource
          manualImagePath: requestBody.manualImagePath
          manualImageAltText: requestBody.manualImageAltText
      - text: Overwrite the full brand category image record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BrandCategoryImages({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a brand category image
      effect: destructive
      questions:
      - How do I remove one image from a brand category page?
      - Can I guard a brand category image delete with an ETag?
      instructions:
      - text: Delete brand category image {id}.
        slots:
          id: path.id
      - text: Delete brand category image {id} if it still matches ETag {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BrandCategoryImages({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields on a brand category image
      effect: write
      questions:
      - Can I just change the alt text on a brand category image?
      - Is it possible to switch a brand category image to use a different product's picture?
      instructions:
      - text: Change the manual alt text of brand category image {id} to {manualImageAltText}.
        slots:
          id: path.id
          manualImageAltText: requestBody.manualImageAltText
      - text: Patch brand category image {id} to use the picture of product {manualImageProductId}.
        slots:
          id: path.id
          manualImageProductId: requestBody.manualImageProductId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BrandCategoryImages/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the brand category images Default function
      effect: read
      questions:
      - What does the Default function on brand category images return?
      - Is there a default brand category image entry I can fetch?
      instructions:
      - text: Call the Default function on brand category images.
      - text: Fetch the default brand category image result.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/brandcategoryimages/manualproductimages(brandId={brandId},parentCategoryId={parentCategoryId})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get product images to choose for a brand category
      effect: read
      questions:
      - Which product images can I pick from when setting a manual image for a brand's category?
      - Can I see the candidate product pictures for a brand under a parent category?
      instructions:
      - text: List the manual product images for brand {brandId} under parent category {parentCategoryId}.
        slots:
          brandId: path.brandId
          parentCategoryId: path.parentCategoryId
      - text: Show product picture options for brand {brandId} in category {parentCategoryId}.
        slots:
          brandId: path.brandId
          parentCategoryId: path.parentCategoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/brandcategoryimages/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete brand category images by id
      effect: destructive
      questions:
      - Can I clear out several brand category images at once?
      - Is there a bulk delete that takes a list of brand category image ids?
      instructions:
      - text: Delete brand category images {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove the brand category images with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/brandcategoryimages({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a brand category image
      effect: read
      questions:
      - Where can I read a custom property saved on a brand category image?
      - Can I fetch a single custom property value for one brand category image?
      instructions:
      - text: Get custom property {custompropertyKey} of brand category image {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the custom value {custompropertyKey} stored on brand category image {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'