API Evangelist conversational phrasing for Acquia Cloud API Documentation Codebases API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Acquia Cloud API Documentation Codebases API
  version: 1.0.0
extends: openapi/acquia-codebases-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 12
- target: $.paths['/codebases/{codebaseId}/bulk-code-switch'].get
  update:
    x-apievangelist-phrasing:
      intent: List past bulk code switches on a codebase
      effect: read
      questions:
      - What bulk code switches have already been run against a codebase?
      - Can I page through the history of bulk code switch operations for one codebase?
      instructions:
      - text: List the bulk code switches performed on codebase {codebase}.
        slots:
          codebase: path.codebaseId
      - text: Show the {limit} most recent bulk code switches on codebase {codebase}.
        slots:
          limit: query.limit
          codebase: path.codebaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/codebases/{codebaseId}/bulk-code-switch'].post
  update:
    x-apievangelist-phrasing:
      intent: Switch many environments to one git reference
      effect: write
      questions:
      - How do I move several environments to the same branch or tag in one go?
      - Can a bulk code switch run Cloud Actions on each target afterward?
      instructions:
      - text: Start a bulk code switch on codebase {codebase} to reference {reference} for targets {targets}.
        slots:
          codebase: path.codebaseId
          reference: requestBody.reference
          targets: requestBody.targets
      - text: Switch environments {targets} of codebase {codebase} to {reference} in bulk and run cloud actions {cloud_actions}.
        slots:
          targets: requestBody.targets
          codebase: path.codebaseId
          reference: requestBody.reference
          cloud_actions: requestBody.cloud_actions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/codebases/{codebaseId}/bulk-code-switch/{bulkCodeSwitchId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check on one bulk code switch
      effect: read
      questions:
      - Did a particular bulk code switch finish, and which targets did it touch?
      - What are the details of one bulk code switch by its ID?
      instructions:
      - text: Get bulk code switch {switch} on codebase {codebase}.
        slots:
          switch: path.bulkCodeSwitchId
          codebase: path.codebaseId
      - text: Show the status of bulk switch {switch} for codebase {codebase}.
        slots:
          switch: path.bulkCodeSwitchId
          codebase: path.codebaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{applicationId}/codebase'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the codebase linked to an application
      effect: read
      questions:
      - Which codebase is an application built from?
      - Can I look up the codebase attached to a given application ID?
      instructions:
      - text: Show the codebase linked to application {application}.
        slots:
          application: path.applicationId
      - text: Find which codebase application {application} uses.
        slots:
          application: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/codebases'].get
  update:
    x-apievangelist-phrasing:
      intent: List all codebases I can access
      effect: read
      questions:
      - What codebases do I have access to across Acquia?
      - Which codebases can my user account see?
      instructions:
      - text: List every codebase I can access.
      - text: Show all the codebases available to my user.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/codebases/{codebaseId}'].get
  update:
    x-apievangelist-phrasing:
      intent: View details of one codebase
      effect: read
      questions:
      - What are the label, description and details of a specific codebase?
      - Can I pull up a single codebase by its ID?
      instructions:
      - text: Get the details of codebase {codebase}.
        slots:
          codebase: path.codebaseId
      - text: Open codebase {codebase} and tell me what's in it.
        slots:
          codebase: path.codebaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/codebases/{codebaseId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a codebase
      effect: write
      questions:
      - How do I change the label shown for a codebase?
      - Can I edit a codebase's description after it's created?
      instructions:
      - text: Rename codebase {codebase} to {label}.
        slots:
          codebase: path.codebaseId
          label: requestBody.label
      - text: Set the description of codebase {codebase} to {description}.
        slots:
          codebase: path.codebaseId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/codebases/{codebaseId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a codebase
      effect: destructive
      questions:
      - Can I permanently remove a codebase I no longer use?
      - What's the way to delete a codebase by its ID?
      instructions:
      - text: Delete codebase {codebase}.
        slots:
          codebase: path.codebaseId
      - text: Remove codebase {codebase} entirely.
        slots:
          codebase: path.codebaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/codebases'].get
  update:
    x-apievangelist-phrasing:
      intent: List codebases under a subscription
      effect: read
      questions:
      - Which codebases belong to one of my subscriptions?
      - How many codebases does a given subscription hold?
      instructions:
      - text: List the codebases in subscription {subscription}.
        slots:
          subscription: path.subscriptionId
      - text: Show every codebase attached to subscription {subscription}.
        slots:
          subscription: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/codebases'].options
  update:
    x-apievangelist-phrasing:
      intent: See regions available for a new codebase
      effect: read
      questions:
      - Which regions can I create a new codebase in for this subscription?
      - Where is a new codebase allowed to be hosted under my subscription?
      instructions:
      - text: Show the supported regions for a new codebase in subscription {subscription}.
        slots:
          subscription: path.subscriptionId
      - text: Check which hosting regions subscription {subscription} allows for new codebases.
        slots:
          subscription: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/codebases/{codebaseId}/references'].get
  update:
    x-apievangelist-phrasing:
      intent: List git branches and tags in a codebase
      effect: read
      questions:
      - What branches and tags exist in a codebase's git repository?
      - Which git references could I deploy from this codebase?
      instructions:
      - text: List the git references in codebase {codebase}.
        slots:
          codebase: path.codebaseId
      - text: Show all branches and tags available in codebase {codebase}.
        slots:
          codebase: path.codebaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/codebases/{codebaseId}/references/{referenceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one git reference in a codebase
      effect: read
      questions:
      - What commit does a particular branch or tag point to in my codebase?
      - Does a specific git reference exist in this codebase?
      instructions:
      - text: Get git reference {reference} from codebase {codebase}.
        slots:
          reference: path.referenceName
          codebase: path.codebaseId
      - text: Look up the {reference} branch or tag in codebase {codebase}.
        slots:
          reference: path.referenceName
          codebase: path.codebaseId
      method: generated
      generated: '2026-09-26'