# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for dotCMS REST Bundle API
  version: 1.0.0
extends: openapi/dotcms-bundle-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: 16
- target: $.paths['/api/bundlePublisher/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Receive and publish an incoming bundle
      effect: write
      questions:
      - How does a receiving dotCMS server accept a pushed bundle and publish it?
      - Can I force-push a bundle to the receiver even if nothing changed?
      instructions:
      - text: Publish the incoming bundle with FORCE_PUSH set to {FORCE_PUSH}.
        slots:
          FORCE_PUSH: query.FORCE_PUSH
      - text: Push the bundle through the bundle publisher using filter {filterkey}.
        slots:
          filterkey: query.filterkey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/bundle/all'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete every bundle
      effect: destructive
      questions:
      - Can I wipe the entire publishing queue history of bundles in one go?
      - What deletes all bundles regardless of whether they succeeded or failed?
      instructions:
      - text: Delete every bundle in the publishing history.
      - text: Clear all bundles, successful and failed alike.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/bundle/all/fail'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all failed bundles
      effect: destructive
      questions:
      - How do I clean up only the bundles that failed to publish?
      - Can I remove failed bundles but keep the successful ones?
      instructions:
      - text: Delete all bundles that failed to publish.
      - text: Clear the failed bundles from the publishing history.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/bundle/all/success'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all successfully published bundles
      effect: destructive
      questions:
      - Can I purge bundles that already published successfully?
      - Which call removes only the successful bundles from history?
      instructions:
      - text: Delete all bundles that published successfully.
      - text: Clear the successful bundles and keep the failed ones for review.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/bundle/ids'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete specific bundles by ID
      effect: destructive
      questions:
      - Can I delete a handful of bundles by listing their IDs?
      - How do I remove particular bundles from the publishing history?
      instructions:
      - text: Delete the bundles with IDs {identifiers}.
        slots:
          identifiers: requestBody.identifiers
      - text: Remove bundles {identifiers} from the publish history.
        slots:
          identifiers: requestBody.identifiers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/bundle/olderthan/{olderThan}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete bundles older than a date
      effect: destructive
      questions:
      - Can I clean out old bundles created before a certain date?
      - What removes stale bundles by age?
      instructions:
      - text: Delete all bundles older than {olderThan}.
        slots:
          olderThan: path.olderThan
      - text: Purge bundles created before {olderThan}.
        slots:
          olderThan: path.olderThan
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/bundle/deleteenvironmentpushhistory/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Clear push history for an environment
      effect: destructive
      questions:
      - Can I reset the push history for one publishing environment so everything pushes again?
      - Which call clears what was already pushed to a given environment?
      instructions:
      - text: Delete the push history for environment {params}.
        slots:
          params: path.params
      - text: Clear the record of assets pushed to the environment in {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/bundle/deletepushhistory/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Clear push history for an asset
      effect: destructive
      questions:
      - How do I clear the push history of a single piece of content?
      - Can I forget that an asset was pushed so it is sent again next time?
      instructions:
      - text: Delete the push history for the asset in {params}.
        slots:
          params: path.params
      - text: Clear push records for asset {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/bundle/_download/{bundleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a bundle file
      effect: read
      questions:
      - Can I download a generated bundle as a file to move it manually?
      - Where do I fetch the archive for a bundle I already generated?
      instructions:
      - text: Download bundle {bundleId}.
        slots:
          bundleId: path.bundleId
      - text: Save the file for bundle {bundleId} so I can upload it elsewhere.
        slots:
          bundleId: path.bundleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/bundle/{bundleId}/manifest'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a bundle's manifest
      effect: read
      questions:
      - What assets are listed in a bundle's manifest?
      - Can I get just the manifest of a bundle rather than the whole file?
      instructions:
      - text: Download the manifest of bundle {bundleId}.
        slots:
          bundleId: path.bundleId
      - text: Show me the manifest file for bundle {bundleId}.
        slots:
          bundleId: path.bundleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/bundle/_generate'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a bundle file
      effect: write
      questions:
      - How do I build a bundle so it can be downloaded?
      - Can I generate a bundle for an unpublish operation instead of a publish?
      instructions:
      - text: Generate bundle {bundleId} for operation {operation}.
        slots:
          bundleId: requestBody.bundleId
          operation: requestBody.operation
      - text: Build bundle {bundleId} using push filter {filterKey}.
        slots:
          bundleId: requestBody.bundleId
          filterKey: requestBody.filterKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/bundle/{bundleId}/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List the assets in a bundle
      effect: read
      questions:
      - Which content and assets are queued inside a bundle?
      - Can I limit how many assets of a bundle are returned?
      instructions:
      - text: List the assets in bundle {bundleId}.
        slots:
          bundleId: path.bundleId
      - text: Show the first {limit} assets queued in bundle {bundleId}.
        slots:
          limit: query.limit
          bundleId: path.bundleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/bundle/getunsendbundles/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: List bundles not yet sent
      effect: read
      questions:
      - Which bundles are still waiting to be sent?
      - Can I review bundles that were created but never pushed?
      instructions:
      - text: List the unsent bundles using {params}.
        slots:
          params: path.params
      - text: Show the bundles still waiting to be pushed for {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/bundle/updatebundle/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Rename or update an unsent bundle
      effect: write
      questions:
      - Can I rename a bundle before sending it?
      - Which call changes the details of a bundle that hasn't been pushed yet?
      instructions:
      - text: Update the bundle described by {params}.
        slots:
          params: path.params
      - text: Change the name of the unsent bundle given in {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/bundle'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a bundle for async publishing
      effect: write
      questions:
      - How do I upload a bundle file and let it publish in the background?
      - Can I import a downloaded bundle without waiting for it to finish?
      instructions:
      - text: Upload bundle file {entity} and publish it asynchronously.
        slots:
          entity: requestBody.entity
      - text: Import the bundle in {bodyParts} and return right away while it processes.
        slots:
          bodyParts: requestBody.bodyParts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/bundle/sync'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a bundle and wait for publishing
      effect: write
      questions:
      - Can I upload a bundle and block until it has finished publishing?
      - Which upload endpoint returns the publish result in the same response?
      instructions:
      - text: Upload bundle file {entity} synchronously and wait for the result.
        slots:
          entity: requestBody.entity
      - text: Import the bundle in {bodyParts} and report when publishing completes.
        slots:
          bodyParts: requestBody.bodyParts
      method: generated
      generated: '2026-09-26'