# 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 Workflows API
  version: 1.0.0
extends: openapi/ios-ciworkflows-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: 8
- target: $.paths['/v1/ciWorkflows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Xcode Cloud workflow
      effect: write
      questions:
      - How do I create a new Xcode Cloud workflow for my product?
      - Can I define start conditions and actions when creating a CI workflow?
      instructions:
      - text: Create an Xcode Cloud workflow from {workflow}.
        slots:
          workflow: requestBody.data
      - text: Set up a new CI workflow that builds on every push, using {workflow}.
        slots:
          workflow: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciWorkflows/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Xcode Cloud workflow
      effect: read
      questions:
      - What triggers and actions are configured on one of my Xcode Cloud workflows?
      - Is a particular CI workflow enabled or locked?
      instructions:
      - text: Show Xcode Cloud workflow {id}.
        slots:
          id: path.id
      - text: Fetch the configuration of CI workflow {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciWorkflows/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Xcode Cloud workflow
      effect: destructive
      questions:
      - Can I delete an Xcode Cloud workflow I no longer use?
      - What happens to a CI workflow's configuration when I remove it?
      instructions:
      - text: Delete Xcode Cloud workflow {id}.
        slots:
          id: path.id
      - text: Remove CI workflow {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciWorkflows/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an Xcode Cloud workflow
      effect: write
      questions:
      - How can I disable an Xcode Cloud workflow without deleting it?
      - Can I change a CI workflow's name or start conditions?
      instructions:
      - text: Update Xcode Cloud workflow {id} with {changes}.
        slots:
          id: path.id
          changes: requestBody.data
      - text: Disable CI workflow {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciWorkflows/{id}/relationships/buildRuns'].get
  update:
    x-apievangelist-phrasing:
      intent: List build run IDs for a workflow
      effect: read
      questions:
      - Which build run IDs has my Xcode Cloud workflow produced?
      - Can I get just the identifiers of a workflow's runs?
      instructions:
      - text: List the build run IDs linked to workflow {id}.
        slots:
          id: path.id
      - text: Return only run references for CI workflow {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciWorkflows/{id}/buildRuns'].get
  update:
    x-apievangelist-phrasing:
      intent: List a workflow's build runs
      effect: read
      questions:
      - What were the results of the recent Xcode Cloud runs for this workflow?
      - Can I find the workflow run that produced a specific build?
      instructions:
      - text: Show the full build runs for workflow {id}, sorted by {sort}.
        slots:
          id: path.id
          sort: query.sort
      - text: Find the run of workflow {id} that produced build {build}.
        slots:
          id: path.id
          build: query.filter[builds]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciWorkflows/{id}/relationships/repository'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the repository ID for a workflow
      effect: read
      questions:
      - Which repository ID is my Xcode Cloud workflow connected to?
      - Can I fetch only the source repo identifier for a workflow?
      instructions:
      - text: Get the repository ID linked to workflow {id}.
        slots:
          id: path.id
      - text: Return only the source repo reference for CI workflow {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciWorkflows/{id}/repository'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the repository a workflow builds
      effect: read
      questions:
      - What Git repository and URL does this Xcode Cloud workflow build from?
      - Who owns the source repository behind my CI workflow?
      instructions:
      - text: Show the full repository details for workflow {id}.
        slots:
          id: path.id
      - text: Tell me the Git URL and owner of the repo CI workflow {id} uses.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'