OutSystems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Native Mobile Build Build Operations API

7 actions 7 updates phrasing extends openapi/outsystems-buildoperations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for OutSystems's API. It is a proposal applied on top of the contract, not a document OutSystems publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/build-operations/{operationKey}'].get
$.paths['/build-operations/{operationKey}/log-messages'].get
$.paths['/build-operations'].get
$.paths['/build-operations'].post
$.paths['/build-operations/version-suggestions'].post
$.paths['/build-operations/native-build-validation'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Native Mobile Build Build Operations API
  version: 1.0.0
extends: openapi/outsystems-buildoperations-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 a native mobile build's details
      effect: read
      questions:
      - How do I check the status of a native mobile build I started?
      - What details come back for a single iOS or Android build operation?
      instructions:
      - text: Get the details of native build operation {operationKey}.
        slots:
          operationKey: path.operationKey
      - text: Check how native build {operationKey} for app {applicationKey} is doing.
        slots:
          operationKey: path.operationKey
          applicationKey: query.applicationKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/build-operations/{operationKey}/log-messages'].get
  update:
    x-apievangelist-phrasing:
      intent: Read progress messages of a native build
      effect: read
      questions:
      - Can I follow step-by-step progress of my native mobile build?
      - Where are the progress messages for an iOS or Android build?
      instructions:
      - text: Show the progress messages for native build {operationKey}.
        slots:
          operationKey: path.operationKey
      - text: Get the latest {limit} progress messages of native build {operationKey}.
        slots:
          limit: query.limit
          operationKey: path.operationKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/build-operations'].get
  update:
    x-apievangelist-phrasing:
      intent: List native mobile builds
      effect: read
      questions:
      - Which native mobile builds have run for my app?
      - Can I filter native builds by platform or by build status?
      instructions:
      - text: List native builds for app {applicationKey} in stage {environmentKey}.
        slots:
          applicationKey: query.applicationKey
          environmentKey: query.environmentKey
      - text: Show the {mobilePlatform} native builds with status {status}.
        slots:
          mobilePlatform: query.mobilePlatform
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/build-operations'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a native mobile build
      effect: write
      questions:
      - How do I kick off a new iOS or Android build of my mobile app?
      - Can I set the mobile version number and version code for a native build?
      instructions:
      - text: Start a native {mobilePlatform} build of app {applicationKey} in stage {environmentKey}.
        slots:
          mobilePlatform: requestBody.mobilePlatform
          applicationKey: requestBody.applicationKey
          environmentKey: requestBody.environmentKey
      - text: Build app {applicationKey} natively with version number {mobileVersionNumber} and code {mobileVersionCode}.
        slots:
          applicationKey: requestBody.applicationKey
          mobileVersionNumber: requestBody.mobileVersionNumber
          mobileVersionCode: requestBody.mobileVersionCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/build-operations/version-suggestions'].post
  update:
    x-apievangelist-phrasing:
      intent: Suggest the next mobile build version
      effect: read
      questions:
      - What version number and version code should my next mobile build use?
      - Can I get suggested next versions for both iOS and Android at once?
      instructions:
      - text: Suggest the next build version for app {applicationKey} in stage {environmentKey}.
        slots:
          applicationKey: requestBody.applicationKey
          environmentKey: requestBody.environmentKey
      - text: Get the suggested {mobilePlatform} version code for app {applicationKey}'s next build.
        slots:
          mobilePlatform: requestBody.mobilePlatform
          applicationKey: requestBody.applicationKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/build-operations/native-build-validation'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether a new native build is needed
      effect: read
      questions:
      - Are my iOS and Android build artifacts still up to date, or do I need to rebuild?
      - Can I check if a native rebuild is required for just one platform?
      instructions:
      - text: Check whether app {applicationKey} needs a new native build in stage {environmentKey}.
        slots:
          applicationKey: requestBody.applicationKey
          environmentKey: requestBody.environmentKey
      - text: Validate if the {mobilePlatform} build of app {applicationKey} is out of date.
        slots:
          mobilePlatform: requestBody.mobilePlatform
          applicationKey: requestBody.applicationKey
      method: generated
      generated: '2026-10-01'