# 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 Ci Build Runs API
  version: 1.0.0
extends: openapi/ios-cibuildruns-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/ciBuildRuns'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an Xcode Cloud build
      effect: write
      questions:
      - How do I trigger a new Xcode Cloud build from the API?
      - Can I start a build run for a specific workflow or rebuild an earlier run?
      instructions:
      - text: Start an Xcode Cloud build run with {data}.
        slots:
          data: requestBody.data
      - text: Kick off a new CI build using {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciBuildRuns/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Xcode Cloud build run
      effect: read
      questions:
      - What is the status of a particular Xcode Cloud build run?
      - Can I see when a build run started and how it finished?
      instructions:
      - text: Show Xcode Cloud build run {id}.
        slots:
          id: path.id
      - text: Fetch build run {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciBuildRuns/{id}/relationships/actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List IDs of a build run's actions
      effect: read
      questions:
      - Can I get just the action IDs for an Xcode Cloud build run?
      - Which build action identifiers belong to a run?
      instructions:
      - text: Give me the action IDs for build run {id}.
        slots:
          id: path.id
      - text: Return {limit} action linkages for CI build run {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciBuildRuns/{id}/actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the actions in a build run
      effect: read
      questions:
      - What steps (build, test, analyze, archive) ran in my Xcode Cloud build?
      - Which action in a build run failed?
      instructions:
      - text: Show the actions for build run {id}.
        slots:
          id: path.id
      - text: List CI actions of build run {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciBuildRuns/{id}/relationships/builds'].get
  update:
    x-apievangelist-phrasing:
      intent: List IDs of builds from a build run
      effect: read
      questions:
      - Can I fetch only the build IDs a CI run produced?
      - Which build identifiers came out of an Xcode Cloud run?
      instructions:
      - text: Give me the IDs of builds produced by run {id}.
        slots:
          id: path.id
      - text: Retrieve up to {limit} uploaded-build references that came out of run {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciBuildRuns/{id}/builds'].get
  update:
    x-apievangelist-phrasing:
      intent: List builds produced by a build run
      effect: read
      questions:
      - What app builds did an Xcode Cloud run upload?
      - Can I filter a run's builds by version, processing state or whether they're expired?
      instructions:
      - text: Show the builds created by build run {id}.
        slots:
          id: path.id
      - text: List builds from run {id} with version {version}.
        slots:
          id: path.id
          version: query.filter[version]
      - text: Show builds from run {id} whose processing state is {processingState}.
        slots:
          id: path.id
          processingState: query.filter[processingState]
      method: generated
      generated: '2026-10-01'