# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Operations Build API
  version: 1.0.0
extends: openapi/outsystems-build-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['/build-operations/{operationKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of an asset build
      effect: read
      questions:
      - How do I check the outcome of a build I started for an asset revision?
      - What details does ODC return for a single asset build operation?
      instructions:
      - text: Get the details of asset build {operationKey}.
        slots:
          operationKey: path.operationKey
      - text: Check whether build {operationKey} for my asset revision finished.
        slots:
          operationKey: path.operationKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/build-operations/{operationKey}/log-messages'].get
  update:
    x-apievangelist-phrasing:
      intent: Read an asset build's log messages
      effect: read
      questions:
      - Why did my asset build fail, according to its log?
      - Can I read the messages logged while an asset revision was being built?
      instructions:
      - text: Show the log messages for asset build {operationKey}.
        slots:
          operationKey: path.operationKey
      - text: Get the build feedback logged by {operationKey}.
        slots:
          operationKey: path.operationKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/build-operations/{operationKey}/generated-code'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a build's packaged generated code
      effect: read
      questions:
      - Where do I get the generated code once its packaging has finished?
      - Can I download the code a build produced for my asset?
      instructions:
      - text: Get the packaged generated code for build {operationKey}.
        slots:
          operationKey: path.operationKey
      - text: Download the generated code output of build {operationKey}.
        slots:
          operationKey: path.operationKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/build-operations/{operationKey}/generated-code'].post
  update:
    x-apievangelist-phrasing:
      intent: Start packaging a build's generated code
      effect: write
      questions:
      - How do I ask ODC to package the generated code of a build so I can download it?
      - What step must run before the generated code of a build is available?
      instructions:
      - text: Start packaging the generated code for build {operationKey}.
        slots:
          operationKey: path.operationKey
      - text: Prepare the generated code of build {operationKey} for download.
        slots:
          operationKey: path.operationKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/build-operations'].get
  update:
    x-apievangelist-phrasing:
      intent: List builds for an asset revision
      effect: read
      questions:
      - What builds have been created for a given revision of my asset?
      - Can I filter an asset's builds by build type, such as Release?
      instructions:
      - text: List builds for asset {assetKey} revision {assetRevision}.
        slots:
          assetKey: query.assetKey
          assetRevision: query.assetRevision
      - text: Show {byBuildType} builds created for asset {assetKey}.
        slots:
          byBuildType: query.byBuildType
          assetKey: query.assetKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/build-operations'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a build of an asset revision
      effect: write
      questions:
      - How do I trigger a Release build for a particular revision of an asset?
      - Which build types can I choose when building an asset revision?
      instructions:
      - text: Build revision {assetRevision} of asset {assetKey}.
        slots:
          assetRevision: requestBody.assetRevision
          assetKey: requestBody.assetKey
      - text: Start a {buildType} build of asset {assetKey} at revision {assetRevision}.
        slots:
          buildType: requestBody.buildType
          assetKey: requestBody.assetKey
          assetRevision: requestBody.assetRevision
      method: generated
      generated: '2026-10-01'