# 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 Store Versions API
  version: 1.0.0
extends: openapi/ios-appstoreversions-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: 30
- target: $.paths['/v1/appStoreVersions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new App Store version for an app
      effect: write
      questions:
      - How do I start a new App Store version so I can prepare my next release in App Store Connect?
      - Can I create a version record with a version string and platform before uploading a build?
      instructions:
      - text: 'Create a new App Store version with these attributes: {data}.'
        slots:
          data: requestBody.data
      - text: Open a new App Store version for my next iOS release using {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an App Store version
      effect: read
      questions:
      - What state is a specific App Store version in right now?
      - Can I look up the version string, platform and release type of one App Store version?
      instructions:
      - text: Show me App Store version {id}.
        slots:
          id: path.id
      - text: Fetch the details and current state of App Store version {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an App Store version
      effect: destructive
      questions:
      - Can I throw away an App Store version I created by mistake?
      - Is it possible to remove an unreleased app version entirely?
      instructions:
      - text: Delete App Store version {id}.
        slots:
          id: path.id
      - text: Remove the draft App Store version {id} I no longer need.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an App Store version
      effect: write
      questions:
      - Can I change the version string or release type of an App Store version that already exists?
      - Which settings on an existing App Store version, such as copyright or scheduled release date, can I edit?
      instructions:
      - text: Update App Store version {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Change the copyright and release settings on existing version {id} to {data}.
        slots:
          id: path.id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/relationships/alternativeDistributionPackage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the alternative distribution package ID for a version
      effect: read
      questions:
      - Which alternative distribution package ID is linked to an App Store version, without the full package details?
      - Is there an alternative distribution package reference attached to this version at all?
      instructions:
      - text: Give me only the linked alternative distribution package ID for version {id}.
        slots:
          id: path.id
      - text: Check whether App Store version {id} has an alternative distribution package linkage.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/alternativeDistributionPackage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the alternative distribution package for a version
      effect: read
      questions:
      - Where can I see the full alternative distribution package record for an App Store version?
      - What does the alternative marketplace distribution package for my release contain?
      instructions:
      - text: Show the full alternative distribution package for App Store version {id}.
        slots:
          id: path.id
      - text: Fetch the alternative distribution package details tied to version {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/relationships/appClipDefaultExperience'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the App Clip default experience ID for a version
      effect: read
      questions:
      - Which App Clip default experience ID is currently linked to an App Store version?
      - Can I get just the reference to a version's default App Clip experience, not the full record?
      instructions:
      - text: Return only the App Clip default experience ID linked to version {id}.
        slots:
          id: path.id
      - text: Check which default App Clip experience linkage version {id} points at.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/relationships/appClipDefaultExperience'].patch
  update:
    x-apievangelist-phrasing:
      intent: Link a default App Clip experience to a version
      effect: write
      questions:
      - Can I point an App Store version at a different default App Clip experience?
      - What is the way to attach an existing App Clip default experience to my release?
      instructions:
      - text: Set the default App Clip experience of version {id} to {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Relink App Store version {id} to App Clip default experience {data}.
        slots:
          id: path.id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/appClipDefaultExperience'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the App Clip default experience for a version
      effect: read
      questions:
      - What does the default App Clip experience for an App Store version look like in full?
      - Can I read the action and subtitle of the App Clip card shipped with a release?
      instructions:
      - text: Show the full default App Clip experience for App Store version {id}.
        slots:
          id: path.id
      - text: Fetch the App Clip default experience details attached to version {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/relationships/appStoreReviewDetail'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the App Review detail ID for a version
      effect: read
      questions:
      - Which App Store review detail ID belongs to an App Store version?
      - Can I get only the linkage to a version's review detail without the contact info?
      instructions:
      - text: Return just the App Store review detail ID linked to version {id}.
        slots:
          id: path.id
      - text: Look up the review detail reference for App Store version {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/appStoreReviewDetail'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the App Review contact and demo details for a version
      effect: read
      questions:
      - What reviewer contact info, demo account and notes did I give App Review for this version?
      - Can I check the review notes submitted alongside a specific app version?
      instructions:
      - text: Show the App Review contact, demo login and notes for version {id}.
        slots:
          id: path.id
      - text: Fetch the full App Store review detail for App Store version {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/relationships/appStoreVersionExperiments'].get
  update:
    x-apievangelist-phrasing:
      intent: List product page experiment IDs for a version
      effect: read
      questions:
      - Which product page optimization experiment IDs are linked to an App Store version under the original experiments model?
      - Can I get just the IDs of the v1 experiments on a version without their details?
      instructions:
      - text: List only the IDs of the original (v1) product page experiments on version {id}.
        slots:
          id: path.id
      - text: Give me up to {limit} v1 experiment linkages for App Store version {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/appStoreVersionExperiments'].get
  update:
    x-apievangelist-phrasing:
      intent: List product page experiments for a version
      effect: read
      questions:
      - What product page optimization tests are running on this app version under the original experiments API?
      - Can I filter a version's v1 experiments by state, like only the ones in review or completed?
      instructions:
      - text: Show the full original (v1) product page experiments for version {id}.
        slots:
          id: path.id
      - text: List v1 experiments on version {id} that are in state {state}.
        slots:
          id: path.id
          state: query.filter[state]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/relationships/appStoreVersionExperimentsV2'].get
  update:
    x-apievangelist-phrasing:
      intent: List V2 product page experiment IDs for a version
      effect: read
      questions:
      - Which V2 product page experiment IDs are attached to an App Store version?
      - Can I fetch only the linkages for the newer V2 experiments on a version?
      instructions:
      - text: List only the IDs of the V2 product page experiments on version {id}.
        slots:
          id: path.id
      - text: Return up to {limit} V2 experiment linkages for App Store version {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/appStoreVersionExperimentsV2'].get
  update:
    x-apievangelist-phrasing:
      intent: List V2 product page experiments for a version
      effect: read
      questions:
      - What V2 product page optimization experiments exist for this app version, with their full details?
      - Is there a way to see only the V2 experiments on a version that are currently running?
      instructions:
      - text: Show the full V2 product page experiments for App Store version {id}.
        slots:
          id: path.id
      - text: List the V2 experiments on version {id} whose state is {state}.
        slots:
          id: path.id
          state: query.filter[state]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/relationships/appStoreVersionLocalizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List localization IDs for an App Store version
      effect: read
      questions:
      - Which localization IDs are attached to an App Store version?
      - Can I get just the localization references for a version without the description text?
      instructions:
      - text: List only the localization IDs for App Store version {id}.
        slots:
          id: path.id
      - text: Return up to {limit} localization linkages for version {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/appStoreVersionLocalizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List localized metadata for an App Store version
      effect: read
      questions:
      - What descriptions, keywords and what's-new text does my version have in each language?
      - Can I pull the localized store metadata of a version for just one locale, like de-DE?
      instructions:
      - text: Show every localization with its store text for App Store version {id}.
        slots:
          id: path.id
      - text: Get the {locale} localization of App Store version {id}.
        slots:
          id: path.id
          locale: query.filter[locale]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/relationships/appStoreVersionPhasedRelease'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the phased release ID for a version
      effect: read
      questions:
      - Which phased release ID is linked to an App Store version?
      - Can I check whether a version has a phased release reference without loading its state?
      instructions:
      - text: Return only the phased release ID linked to version {id}.
        slots:
          id: path.id
      - text: Check the phased release linkage on App Store version {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/appStoreVersionPhasedRelease'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the phased release status for a version
      effect: read
      questions:
      - How far along is the seven-day phased rollout of my current app version?
      - Is the phased release for this version active, paused or complete?
      instructions:
      - text: Show the phased release state and current day for App Store version {id}.
        slots:
          id: path.id
      - text: Fetch the full phased release record of version {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/relationships/appStoreVersionSubmission'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the review submission ID for a version
      effect: read
      questions:
      - Which App Store version submission ID is linked to this version?
      - Can I get only the submission reference for a version, not the submission itself?
      instructions:
      - text: Return just the version submission ID linked to App Store version {id}.
        slots:
          id: path.id
      - text: Check the submission linkage on version {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/appStoreVersionSubmission'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the review submission for a version
      effect: read
      questions:
      - Has this App Store version been submitted for review, and what does that submission record show?
      - Where do I see the full submission object behind a version sent to App Review?
      instructions:
      - text: Show the full App Store version submission for version {id}.
        slots:
          id: path.id
      - text: Fetch the review submission details attached to version {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/relationships/build'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the build ID attached to a version
      effect: read
      questions:
      - Which build ID is currently selected for an App Store version?
      - Can I get only the build reference for a version without the build metadata?
      instructions:
      - text: Return only the ID of the build attached to App Store version {id}.
        slots:
          id: path.id
      - text: Check which build linkage version {id} is pointing at.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/relationships/build'].patch
  update:
    x-apievangelist-phrasing:
      intent: Attach a build to an App Store version
      effect: write
      questions:
      - How do I choose which uploaded build ships with an App Store version?
      - Can I swap the build on a version before submitting it for review?
      instructions:
      - text: Attach build {data} to App Store version {id}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Replace the selected build on version {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/build'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the build attached to a version
      effect: read
      questions:
      - What build number and upload details belong to the build selected for this version?
      - Can I see whether the build on my release has finished processing?
      instructions:
      - text: Show the full build record attached to App Store version {id}.
        slots:
          id: path.id
      - text: Fetch the build details, including processing state, for version {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/relationships/customerReviews'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer review IDs for a version
      effect: read
      questions:
      - Which customer review IDs were left on a specific App Store version?
      - Can I page through just the review references for a version without the review text?
      instructions:
      - text: List only the customer review IDs for App Store version {id}.
        slots:
          id: path.id
      - text: Return up to {limit} review linkages for version {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/customerReviews'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer reviews for an App Store version
      effect: read
      questions:
      - What are customers saying in reviews of this specific app version?
      - Can I filter a version's reviews to only one-star ratings from a single territory?
      instructions:
      - text: Show the customer reviews written for App Store version {id}.
        slots:
          id: path.id
      - text: List {rating}-star reviews of version {id} from territory {territory}.
        slots:
          id: path.id
          rating: query.filter[rating]
          territory: query.filter[territory]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/relationships/gameCenterAppVersion'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Game Center app version ID for a version
      effect: read
      questions:
      - Which Game Center app version ID is linked to an App Store version?
      - Can I get just the Game Center app version reference for a release?
      instructions:
      - text: Return only the Game Center app version ID linked to version {id}.
        slots:
          id: path.id
      - text: Check the Game Center app version linkage on App Store version {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/gameCenterAppVersion'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Game Center app version for a version
      effect: read
      questions:
      - Is Game Center enabled for this App Store version, and what does its Game Center app version show?
      - Where can I read the full Game Center configuration tied to a release?
      instructions:
      - text: Show the full Game Center app version for App Store version {id}.
        slots:
          id: path.id
      - text: Fetch the Game Center app version record attached to version {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/relationships/routingAppCoverage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the routing app coverage ID for a version
      effect: read
      questions:
      - Which routing app coverage file ID is linked to an App Store version?
      - Can I check only the routing coverage reference on a navigation app's version?
      instructions:
      - text: Return only the routing app coverage ID linked to version {id}.
        slots:
          id: path.id
      - text: Check the routing app coverage linkage on App Store version {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appStoreVersions/{id}/routingAppCoverage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the routing app coverage file for a version
      effect: read
      questions:
      - What geographic routing coverage file did I upload for my navigation app version?
      - Has the routing app coverage file for this version finished processing?
      instructions:
      - text: Show the full routing app coverage file for App Store version {id}.
        slots:
          id: path.id
      - text: Fetch the routing coverage upload details and status for version {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'