# 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 Screenshot Sets API
  version: 1.0.0
extends: openapi/ios-appscreenshotsets-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: 6
- target: $.paths['/v1/appScreenshotSets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a screenshot set for a display size
      effect: write
      questions:
      - How do I add a new screenshot set for a specific device display size?
      - Can I create a screenshot set for a localization or a custom product page?
      instructions:
      - text: Create a screenshot set with {set_details}.
        slots:
          set_details: requestBody.data
      - text: Add a new screenshot set for display type and localization {set_details}.
        slots:
          set_details: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appScreenshotSets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a screenshot set
      effect: read
      questions:
      - What display type and localization does a screenshot set belong to?
      - Can I look up one screenshot set by its ID?
      instructions:
      - text: Get screenshot set {set}.
        slots:
          set: path.id
      - text: Show the details of screenshot set {set}.
        slots:
          set: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appScreenshotSets/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a screenshot set
      effect: destructive
      questions:
      - Can I remove an entire screenshot set for a display size?
      - What happens to the screenshots when I delete their set?
      instructions:
      - text: Delete screenshot set {set}.
        slots:
          set: path.id
      - text: Remove the whole screenshot set {set} from the listing.
        slots:
          set: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appScreenshotSets/{id}/relationships/appScreenshots'].get
  update:
    x-apievangelist-phrasing:
      intent: List screenshot IDs in a set in order
      effect: read
      questions:
      - Can I get only the IDs of the screenshots in a set, in display order?
      - Which screenshot identifiers belong to a screenshot set?
      instructions:
      - text: Get the screenshot IDs in set {set}.
        slots:
          set: path.id
      - text: Return just the ordered screenshot linkages of set {set}.
        slots:
          set: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appScreenshotSets/{id}/relationships/appScreenshots'].patch
  update:
    x-apievangelist-phrasing:
      intent: Reorder the screenshots in a set
      effect: write
      questions:
      - How do I change the order my App Store screenshots appear in?
      - Can I replace the full ordered list of screenshots in a set?
      instructions:
      - text: Reorder the screenshots in set {set} to {screenshots}.
        slots:
          set: path.id
          screenshots: requestBody.data
      - text: Replace the screenshot order of set {set} with {screenshots}.
        slots:
          set: path.id
          screenshots: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appScreenshotSets/{id}/appScreenshots'].get
  update:
    x-apievangelist-phrasing:
      intent: List the screenshots in a set
      effect: read
      questions:
      - What screenshots are in a set, with their file names and upload state?
      - Did all the screenshots in my set finish processing?
      instructions:
      - text: List the screenshots in set {set}.
        slots:
          set: path.id
      - text: Show every screenshot with its asset details in set {set}.
        slots:
          set: path.id
      method: generated
      generated: '2026-10-01'