# 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 Products API
  version: 1.0.0
extends: openapi/ios-ciproducts-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: 13
- target: $.paths['/v1/ciProducts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Xcode Cloud products
      effect: read
      questions:
      - Which of my apps and frameworks are set up in Xcode Cloud?
      - Can I list only the Xcode Cloud products that are frameworks rather than apps?
      instructions:
      - text: List all my Xcode Cloud products.
      - text: Show Xcode Cloud products of type {productType}.
        slots:
          productType: query.filter[productType]
      - text: Find the Xcode Cloud product for app {app}.
        slots:
          app: query.filter[app]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciProducts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Xcode Cloud product
      effect: read
      questions:
      - Can I look up one Xcode Cloud product by its ID?
      - What details does Xcode Cloud store about a single product?
      instructions:
      - text: Show Xcode Cloud product {id}.
        slots:
          id: path.id
      - text: Fetch Xcode Cloud product {id} with {include} included.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciProducts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a product from Xcode Cloud
      effect: destructive
      questions:
      - How do I stop using Xcode Cloud for an app and delete its product?
      - Is deleting an Xcode Cloud product something I can do through the API?
      instructions:
      - text: Delete Xcode Cloud product {id}.
        slots:
          id: path.id
      - text: Remove product {id} and its setup from Xcode Cloud.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciProducts/{id}/relationships/additionalRepositories'].get
  update:
    x-apievangelist-phrasing:
      intent: List IDs of a product's additional repos
      effect: read
      questions:
      - Can I get just the IDs of the extra repositories an Xcode Cloud product uses?
      - Which additional repository identifiers are linked to my CI product?
      instructions:
      - text: Give me the additional repository IDs for Xcode Cloud product {id}.
        slots:
          id: path.id
      - text: Return {limit} additional-repo linkages for CI product {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciProducts/{id}/additionalRepositories'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product's additional repositories
      effect: read
      questions:
      - What secondary repositories does my Xcode Cloud product pull from?
      - Can I check whether a specific repository is among a product's additional repos?
      instructions:
      - text: Show the additional repositories for Xcode Cloud product {id}.
        slots:
          id: path.id
      - text: Check if repository {repo} is an additional repo of product {id}.
        slots:
          id: path.id
          repo: query.filter[id]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciProducts/{id}/relationships/app'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the app ID behind an Xcode Cloud product
      effect: read
      questions:
      - Which app ID is an Xcode Cloud product tied to?
      - Can I get only the app identifier for a CI product?
      instructions:
      - text: Give me the app ID linked to Xcode Cloud product {id}.
        slots:
          id: path.id
      - text: Tell me which app identifier CI product {id} points at.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciProducts/{id}/app'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the app for an Xcode Cloud product
      effect: read
      questions:
      - What app does this Xcode Cloud product build?
      - Can I see full app details starting from a CI product?
      instructions:
      - text: Show the app record for Xcode Cloud product {id}.
        slots:
          id: path.id
      - text: Fetch the app behind CI product {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciProducts/{id}/relationships/buildRuns'].get
  update:
    x-apievangelist-phrasing:
      intent: List IDs of a product's build runs
      effect: read
      questions:
      - Can I fetch only the build run IDs for an Xcode Cloud product?
      - Which build run identifiers belong to my CI product?
      instructions:
      - text: Give me the build run IDs for Xcode Cloud product {id}.
        slots:
          id: path.id
      - text: Return {limit} build run linkages for CI product {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciProducts/{id}/buildRuns'].get
  update:
    x-apievangelist-phrasing:
      intent: List build runs for an Xcode Cloud product
      effect: read
      questions:
      - What builds has Xcode Cloud run for my app recently?
      - Can I sort a product's build runs or find the run that produced a given build?
      instructions:
      - text: Show recent build runs for Xcode Cloud product {id}.
        slots:
          id: path.id
      - text: List build runs of product {id} sorted by {sort}.
        slots:
          id: path.id
          sort: query.sort
      - text: Find the build run of product {id} that produced build {build}.
        slots:
          id: path.id
          build: query.filter[builds]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciProducts/{id}/relationships/primaryRepositories'].get
  update:
    x-apievangelist-phrasing:
      intent: List IDs of a product's primary repos
      effect: read
      questions:
      - How do I get only the primary repository IDs for an Xcode Cloud product?
      - Which main repository identifiers is my CI product connected to?
      instructions:
      - text: Give me the primary repository IDs for Xcode Cloud product {id}.
        slots:
          id: path.id
      - text: Return {limit} primary-repo linkages for CI product {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciProducts/{id}/primaryRepositories'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product's primary repositories
      effect: read
      questions:
      - Which source repository is the main one for my Xcode Cloud product?
      - Can I confirm a specific repo is the primary repository of a product?
      instructions:
      - text: Show the primary repositories for Xcode Cloud product {id}.
        slots:
          id: path.id
      - text: Check if repository {repo} is a primary repo of product {id}.
        slots:
          id: path.id
          repo: query.filter[id]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciProducts/{id}/relationships/workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List IDs of a product's CI workflows
      effect: read
      questions:
      - Can I get just the workflow IDs configured for an Xcode Cloud product?
      - Which workflow identifiers belong to my CI product?
      instructions:
      - text: Give me the workflow IDs for Xcode Cloud product {id}.
        slots:
          id: path.id
      - text: Return {limit} workflow linkages for CI product {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ciProducts/{id}/workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product's Xcode Cloud workflows
      effect: read
      questions:
      - What Xcode Cloud workflows are set up for my app?
      - Where can I see the full workflow definitions for a CI product?
      instructions:
      - text: Show the workflows for Xcode Cloud product {id}.
        slots:
          id: path.id
      - text: List CI workflows of product {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'