# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lightroom API Documentation Albums API
  version: 1.0.0
extends: openapi/adobe-suite-albums-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: 7
- target: $.paths['/v2/catalogs/{catalog_id}/albums/{album_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Lightroom album
      effect: read
      questions:
      - How do I read the details of one album in my Lightroom catalog?
      - Can I fetch a single album's metadata by its ID?
      instructions:
      - text: Show album {album_id} in catalog {catalog_id}.
        slots:
          album_id: path.album_id
          catalog_id: path.catalog_id
      - text: Read the metadata of album {album_id} from catalog {catalog_id}.
        slots:
          album_id: path.album_id
          catalog_id: path.catalog_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/catalogs/{catalog_id}/albums/{album_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an album in a catalog
      effect: write
      questions:
      - How can I create a new album or project set in a Lightroom catalog?
      - Can I choose the album subtype when creating one?
      instructions:
      - text: Create album {album_id} in catalog {catalog_id}.
        slots:
          album_id: path.album_id
          catalog_id: path.catalog_id
      - text: Make a new {subtype} album {album_id} in catalog {catalog_id} with payload {payload}.
        slots:
          subtype: requestBody.subtype
          album_id: path.album_id
          catalog_id: path.catalog_id
          payload: requestBody.payload
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/catalogs/{catalog_id}/albums/{album_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing album
      effect: write
      questions:
      - Can I rename or change an album my app created earlier?
      - Why can't I update an album that another client app created?
      instructions:
      - text: Update album {album_id} in catalog {catalog_id} with {payload}.
        slots:
          album_id: path.album_id
          catalog_id: path.catalog_id
          payload: requestBody.payload
      - text: Rename the existing project album {album_id} in catalog {catalog_id}.
        slots:
          album_id: path.album_id
          catalog_id: path.catalog_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/catalogs/{catalog_id}/albums/{album_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an album
      effect: destructive
      questions:
      - How do I delete an album from my catalog?
      - Can deleting an album also remove its child albums?
      instructions:
      - text: Delete album {album_id} from catalog {catalog_id}.
        slots:
          album_id: path.album_id
          catalog_id: path.catalog_id
      - text: Remove album {album_id} in catalog {catalog_id} along with child albums {child_albums}.
        slots:
          album_id: path.album_id
          catalog_id: path.catalog_id
          child_albums: query.child_albums
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/catalogs/{catalog_id}/albums'].get
  update:
    x-apievangelist-phrasing:
      intent: List albums in a catalog
      effect: read
      questions:
      - What albums exist in my Lightroom catalog?
      - Can I list only project albums, or page through albums by name?
      instructions:
      - text: List the albums in catalog {catalog_id}.
        slots:
          catalog_id: path.catalog_id
      - text: Get up to {limit} {subtype} albums in catalog {catalog_id}.
        slots:
          limit: query.limit
          subtype: query.subtype
          catalog_id: path.catalog_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/catalogs/{catalog_id}/albums/{album_id}/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List the photos and videos in an album
      effect: read
      questions:
      - How do I get all the photos inside a specific album?
      - Can I filter album assets by capture date or flag, or hide stacked ones?
      instructions:
      - text: List the assets in album {album_id} of catalog {catalog_id}.
        slots:
          album_id: path.album_id
          catalog_id: path.catalog_id
      - text: Show photos in album {album_id} of catalog {catalog_id} captured after {captured_after}.
        slots:
          album_id: path.album_id
          catalog_id: path.catalog_id
          captured_after: query.captured_after
      - text: Get {limit} assets with flag {flag} from album {album_id} in catalog {catalog_id}.
        slots:
          limit: query.limit
          flag: query.flag
          album_id: path.album_id
          catalog_id: path.catalog_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/catalogs/{catalog_id}/albums/{album_id}/assets'].put
  update:
    x-apievangelist-phrasing:
      intent: Add assets to an album
      effect: write
      questions:
      - How can I put a batch of photos into an album?
      - Can I set the album cover or asset order when adding assets?
      instructions:
      - text: Add assets {resources} to album {album_id} in catalog {catalog_id}.
        slots:
          resources: requestBody.resources
          album_id: path.album_id
          catalog_id: path.catalog_id
      - text: 'Put these photos into album {album_id} of catalog {catalog_id}: {resources}.'
        slots:
          album_id: path.album_id
          catalog_id: path.catalog_id
          resources: requestBody.resources
      method: generated
      generated: '2026-09-26'