# 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 Background Assets API
  version: 1.0.0
extends: openapi/ios-backgroundassets-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: 5
- target: $.paths['/v1/backgroundAssets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a background asset
      effect: write
      questions:
      - How do I register a new background asset pack for my app?
      - Can I create a background asset through the API?
      instructions:
      - text: Create a background asset with {asset_details}.
        slots:
          asset_details: requestBody.data
      - text: Register a new background asset using {asset_details}.
        slots:
          asset_details: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/backgroundAssets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a background asset
      effect: read
      questions:
      - What details are stored for one background asset?
      - How do I look up a background asset by ID?
      instructions:
      - text: Fetch background asset {asset_id}.
        slots:
          asset_id: path.id
      - text: Show details of background asset {asset_id}.
        slots:
          asset_id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/backgroundAssets/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a background asset
      effect: write
      questions:
      - How do I change a background asset's attributes?
      - Can I edit an existing background asset?
      instructions:
      - text: Update background asset {asset_id} with {changes}.
        slots:
          asset_id: path.id
          changes: requestBody.data
      - text: Edit background asset {asset_id}.
        slots:
          asset_id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/backgroundAssets/{id}/relationships/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List version IDs of a background asset
      effect: read
      questions:
      - How do I get just the version IDs of a background asset?
      - Which version identifiers are linked to a background asset?
      instructions:
      - text: List version IDs for background asset {asset_id}.
        slots:
          asset_id: path.id
      - text: Get only the version linkages of background asset {asset_id}.
        slots:
          asset_id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/backgroundAssets/{id}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List versions of a background asset
      effect: read
      questions:
      - Which versions of a background asset are in beta or on the App Store?
      - Can I filter background asset versions by state or platform?
      - What version number is a background asset currently at?
      instructions:
      - text: Show versions of background asset {asset_id}.
        slots:
          asset_id: path.id
      - text: List versions of background asset {asset_id} in state {state}.
        slots:
          asset_id: path.id
          state: query.filter[state]
      - text: Find version {version} of background asset {asset_id}.
        slots:
          version: query.filter[version]
          asset_id: path.id
      method: generated
      generated: '2026-10-01'