API Evangelist conversational phrasing for App Store Connect Builds API

# 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 Builds API
  version: 1.0.0
extends: openapi/ios-builds-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/builds'].get
  update:
    x-apievangelist-phrasing:
      intent: List builds uploaded to App Store Connect
      effect: read
      questions:
      - How do I list all the builds I've uploaded to App Store Connect?
      - Can I filter my builds to only the ones that are still processing or have expired?
      - Which builds exist for a particular version number of my app?
      instructions:
      - text: List every build for app {app}.
        slots:
          app: query.filter[app]
      - text: Show builds with version {version} that are in processing state {state}.
        slots:
          version: query.filter[version]
          state: query.filter[processingState]
      - text: List builds where expired is {expired}, sorted by {sort}.
        slots:
          expired: query.filter[expired]
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one build's details
      effect: read
      questions:
      - What are the details of a single build, like its version and processing state?
      - Can I fetch one specific build by its ID and pull in its related records too?
      instructions:
      - text: Get the details of build {build}.
        slots:
          build: path.id
      - text: Fetch build {build} and include {include}.
        slots:
          build: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a build's settings
      effect: write
      questions:
      - How do I change attributes on a build, such as marking it expired or setting its encryption flag?
      - Can I edit a build after it has been uploaded?
      instructions:
      - text: Update build {build} with {changes}.
        slots:
          build: path.id
          changes: requestBody.data
      - text: Expire build {build} by setting {changes} on it.
        slots:
          build: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/relationships/app'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the app ID a build belongs to
      effect: read
      questions:
      - Which app ID does a given build belong to, without loading the whole app record?
      - Can I get just the app linkage for a build?
      instructions:
      - text: Give me only the app ID linked to build {build}.
        slots:
          build: path.id
      - text: Return the app relationship identifier for build {build}.
        slots:
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/app'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the full app record for a build
      effect: read
      questions:
      - What app is this build for, with its name and bundle ID?
      - Can I load the full app details starting from a build?
      instructions:
      - text: Show the full app details for the app that build {build} was uploaded to.
        slots:
          build: path.id
      - text: Fetch the app object behind build {build} with fields {fields}.
        slots:
          build: path.id
          fields: query.fields[apps]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/relationships/appEncryptionDeclaration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the encryption declaration ID for a build
      effect: read
      questions:
      - Which export-compliance encryption declaration ID is attached to my build?
      - Is there an encryption declaration linked to this build at all?
      instructions:
      - text: Return only the encryption declaration ID linked to build {build}.
        slots:
          build: path.id
      - text: Check whether build {build} has an encryption declaration linkage.
        slots:
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/relationships/appEncryptionDeclaration'].patch
  update:
    x-apievangelist-phrasing:
      intent: Attach an encryption declaration to a build
      effect: write
      questions:
      - How do I assign an existing export-compliance encryption declaration to a build?
      - Can I swap which encryption declaration a build points to?
      instructions:
      - text: Link encryption declaration {declaration} to build {build}.
        slots:
          declaration: requestBody.data
          build: path.id
      - text: 'Point build {build} at a different encryption declaration: {declaration}.'
        slots:
          build: path.id
          declaration: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/appEncryptionDeclaration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a build's full encryption declaration
      effect: read
      questions:
      - What does the encryption declaration on my build actually say about exempt or proprietary crypto?
      - Can I read the full export-compliance declaration starting from a build?
      instructions:
      - text: Show the full encryption declaration details for build {build}.
        slots:
          build: path.id
      - text: Fetch the export compliance declaration record attached to build {build}.
        slots:
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/relationships/appStoreVersion'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the App Store version ID tied to a build
      effect: read
      questions:
      - Which App Store version ID is this build attached to?
      - Can I see just the version linkage for a build without its details?
      instructions:
      - text: Return only the App Store version ID that build {build} is linked to.
        slots:
          build: path.id
      - text: Look up the version relationship identifier for build {build}.
        slots:
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/appStoreVersion'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the full App Store version for a build
      effect: read
      questions:
      - What App Store version is this build going out with, including its version string and state?
      - Can I load the full App Store version record from a build?
      instructions:
      - text: Show the App Store version details that build {build} is submitted with.
        slots:
          build: path.id
      - text: Fetch the full release version record behind build {build}.
        slots:
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/relationships/betaAppReviewSubmission'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the beta review submission ID for a build
      effect: read
      questions:
      - Has this build been submitted for TestFlight beta review, and what's the submission ID?
      - Can I get only the beta app review submission linkage for a build?
      instructions:
      - text: Return the beta review submission ID linked to build {build}.
        slots:
          build: path.id
      - text: Check if build {build} has a beta app review submission link.
        slots:
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/betaAppReviewSubmission'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a build's beta app review submission status
      effect: read
      questions:
      - What is the TestFlight beta review state of my build right now?
      - Can I see the full beta app review submission record for a build?
      instructions:
      - text: Show the beta app review submission details and state for build {build}.
        slots:
          build: path.id
      - text: Fetch the full external testing review submission for build {build}.
        slots:
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/relationships/betaBuildLocalizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List beta build localization IDs for a build
      effect: read
      questions:
      - Which beta build localization IDs exist for this build?
      - Can I get just the IDs of the localized What to Test notes on a build?
      instructions:
      - text: List only the beta build localization IDs for build {build}.
        slots:
          build: path.id
      - text: Return up to {limit} localization identifiers linked to build {build}.
        slots:
          limit: query.limit
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/betaBuildLocalizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List a build's localized What to Test notes
      effect: read
      questions:
      - What did I write in the What to Test notes for each language on this build?
      - Can I read every localized TestFlight note attached to a build?
      instructions:
      - text: Show the full beta build localizations, with their What to Test text, for build {build}.
        slots:
          build: path.id
      - text: Fetch the localized tester notes on build {build}.
        slots:
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/relationships/betaGroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a build to beta groups
      effect: write
      questions:
      - How do I give a TestFlight beta group access to a new build?
      - Can I add one build to several beta groups at once?
      instructions:
      - text: Add build {build} to beta groups {groups}.
        slots:
          build: path.id
          groups: requestBody.data
      - text: Share build {build} with tester group {groups}.
        slots:
          build: path.id
          groups: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/relationships/betaGroups'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a build from beta groups
      effect: destructive
      questions:
      - How do I stop a TestFlight beta group from getting a particular build?
      - Can I pull a build back from some beta groups but leave it in others?
      instructions:
      - text: Remove build {build} from beta groups {groups}.
        slots:
          build: path.id
          groups: requestBody.data
      - text: Revoke tester group {groups} access to build {build}.
        slots:
          groups: requestBody.data
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/relationships/buildBetaDetail'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the beta detail ID for a build
      effect: read
      questions:
      - What's the ID of the build beta detail record for my build?
      - Can I fetch only the beta detail linkage of a build?
      instructions:
      - text: Return only the build beta detail ID for build {build}.
        slots:
          build: path.id
      - text: Look up which beta detail identifier is linked to build {build}.
        slots:
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/buildBetaDetail'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a build's TestFlight beta details
      effect: read
      questions:
      - Is my build set to auto-notify testers, and what is its internal and external beta state?
      - Where can I see the full TestFlight beta settings for one build?
      instructions:
      - text: Show the full TestFlight beta detail settings for build {build}.
        slots:
          build: path.id
      - text: Fetch internal and external testing state for build {build}.
        slots:
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/relationships/diagnosticSignatures'].get
  update:
    x-apievangelist-phrasing:
      intent: List diagnostic signature IDs for a build
      effect: read
      questions:
      - Which diagnostic signature IDs have been recorded against a build?
      - Can I get just the IDs of hang and disk-write signatures for a build?
      instructions:
      - text: List only the diagnostic signature IDs for build {build}.
        slots:
          build: path.id
      - text: Return up to {limit} diagnostic signature identifiers for build {build}.
        slots:
          limit: query.limit
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/diagnosticSignatures'].get
  update:
    x-apievangelist-phrasing:
      intent: List performance diagnostic signatures for a build
      effect: read
      questions:
      - What performance problems, like hangs or excessive disk writes, has this build been flagged for?
      - Can I see full diagnostic signatures with their weights for a build?
      instructions:
      - text: Show the full diagnostic signatures reported for build {build}.
        slots:
          build: path.id
      - text: List diagnostic signatures of type {type} for build {build}.
        slots:
          type: query.filter[diagnosticType]
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/relationships/icons'].get
  update:
    x-apievangelist-phrasing:
      intent: List icon IDs for a build
      effect: read
      questions:
      - Which icon IDs are attached to a build?
      - Can I get just the identifiers of a build's icons?
      instructions:
      - text: List only the icon IDs linked to build {build}.
        slots:
          build: path.id
      - text: Return the icon relationship identifiers for build {build}.
        slots:
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/icons'].get
  update:
    x-apievangelist-phrasing:
      intent: List the app icons shipped in a build
      effect: read
      questions:
      - What app icons were included in a build I uploaded?
      - Can I see the full icon assets and their types for a build?
      instructions:
      - text: Show the full icon assets bundled in build {build}.
        slots:
          build: path.id
      - text: Fetch icon image details for build {build}.
        slots:
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/relationships/individualTesters'].get
  update:
    x-apievangelist-phrasing:
      intent: List IDs of individual testers on a build
      effect: read
      questions:
      - Which tester IDs were given access to this build individually?
      - Can I get just the IDs of testers assigned directly to a build?
      instructions:
      - text: List only the IDs of individual testers on build {build}.
        slots:
          build: path.id
      - text: Return up to {limit} individually assigned tester identifiers for build {build}.
        slots:
          limit: query.limit
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/relationships/individualTesters'].post
  update:
    x-apievangelist-phrasing:
      intent: Give individual testers access to a build
      effect: write
      questions:
      - How do I let specific beta testers try a build without adding them to a group?
      - Can I assign several testers directly to one build?
      instructions:
      - text: Give testers {testers} individual access to build {build}.
        slots:
          testers: requestBody.data
          build: path.id
      - text: Assign build {build} directly to beta tester {testers}.
        slots:
          build: path.id
          testers: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/relationships/individualTesters'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove individual testers from a build
      effect: destructive
      questions:
      - How do I take away a specific tester's access to one build?
      - Can I remove testers I added individually to a build without touching groups?
      instructions:
      - text: Remove individual testers {testers} from build {build}.
        slots:
          testers: requestBody.data
          build: path.id
      - text: Revoke beta tester {testers} direct access to build {build}.
        slots:
          testers: requestBody.data
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/individualTesters'].get
  update:
    x-apievangelist-phrasing:
      intent: List individual testers with access to a build
      effect: read
      questions:
      - Who are the testers, by name and email, who have direct access to this build?
      - Can I see full tester profiles for everyone individually assigned to a build?
      instructions:
      - text: Show names and emails of the individual testers on build {build}.
        slots:
          build: path.id
      - text: Fetch full tester records for people directly assigned to build {build}.
        slots:
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/perfPowerMetrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get power and performance metrics for a build
      effect: read
      questions:
      - What are the battery, launch time and memory metrics for a specific build?
      - Can I filter a build's performance metrics by device type or platform?
      instructions:
      - text: Get power and performance metrics for build {build}.
        slots:
          build: path.id
      - text: Show {metric} metrics for build {build} on device type {device}.
        slots:
          metric: query.filter[metricType]
          build: path.id
          device: query.filter[deviceType]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/relationships/preReleaseVersion'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the prerelease version ID of a build
      effect: read
      questions:
      - Which prerelease version ID does this build sit under?
      - Can I get only the prerelease version linkage for a build?
      instructions:
      - text: Return only the prerelease version ID for build {build}.
        slots:
          build: path.id
      - text: Look up the prerelease version relationship of build {build}.
        slots:
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/preReleaseVersion'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the full prerelease version for a build
      effect: read
      questions:
      - What prerelease version number and platform is this TestFlight build filed under?
      - Can I load the full prerelease version record from a build?
      instructions:
      - text: Show the prerelease version number and platform for build {build}.
        slots:
          build: path.id
      - text: Fetch the full prerelease train that build {build} belongs to.
        slots:
          build: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/builds/{id}/metrics/betaBuildUsages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get beta usage metrics for a build
      effect: read
      questions:
      - How many TestFlight testers installed, opened or crashed on a given build?
      - What beta usage numbers, like sessions and feedback counts, does a build have?
      instructions:
      - text: Get beta usage metrics for build {build}.
        slots:
          build: path.id
      - text: Show up to {limit} groups of TestFlight usage data for build {build}.
        slots:
          limit: query.limit
          build: path.id
      method: generated
      generated: '2026-10-01'