# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for App Store Connect App Clip Header Images API
  version: 1.0.0
extends: openapi/ios-appclipheaderimages-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: 4
- target: $.paths['/v1/appClipHeaderImages'].post
  update:
    x-apievangelist-phrasing:
      intent: Reserve an App Clip card header image upload
      effect: write
      questions:
      - How do I add a header image to my App Clip card?
      - Can I upload a new App Clip header image through the API?
      instructions:
      - text: Create an App Clip header image with {image}.
        slots:
          image: requestBody.data
      - text: Reserve an upload for a new App Clip card image using {image}.
        slots:
          image: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appClipHeaderImages/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an App Clip header image
      effect: read
      questions:
      - What is the upload state of my App Clip card header image?
      - Can I fetch one App Clip header image's file details?
      instructions:
      - text: Get App Clip header image {image}.
        slots:
          image: path.id
      - text: Check the upload status of App Clip card image {image}.
        slots:
          image: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appClipHeaderImages/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an App Clip header image
      effect: destructive
      questions:
      - How do I remove the header image from an App Clip card?
      - Can I delete an App Clip header image so I can upload a different one?
      instructions:
      - text: Delete App Clip header image {image}.
        slots:
          image: path.id
      - text: Remove the App Clip card artwork {image}.
        slots:
          image: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appClipHeaderImages/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Commit an App Clip header image upload
      effect: write
      questions:
      - Once I've uploaded the App Clip header image bytes, what marks the upload complete?
      - Can I update an App Clip header image record with its checksum?
      instructions:
      - text: Update App Clip header image {image} with {changes}.
        slots:
          image: path.id
          changes: requestBody.data
      - text: Mark the App Clip card image {image} as uploaded using {changes}.
        slots:
          image: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-10-01'