OutSystems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deployments Publish Operations API

5 actions 5 updates phrasing extends openapi/outsystems-publish-operations-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 5

$.info

$.paths['/publish-operations'].get

$.paths['/publish-operations'].post

$.paths['/publish-operations/{operationKey}'].get

$.paths['/publish-operations/{operationKey}/messages'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Deployments Publish Operations API
  version: 1.0.0
extends: openapi/outsystems-publish-operations-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: 4
- target: $.paths['/publish-operations'].get
  update:
    x-apievangelist-phrasing:
      intent: List publications
      effect: read
      questions:
      - Which publish operations ran for my assets recently?
      - Can I filter publications by stage, status or date?
      instructions:
      - text: List publications in stage {environmentKey}.
        slots:
          environmentKey: query.environmentKey
      - text: Show publications of asset {assetKey} with status {status}.
        slots:
          assetKey: query.assetKey
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/publish-operations'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish an asset revision
      effect: write
      questions:
      - How do I publish an asset revision to a stage through the API?
      - What permission is needed to start a publication?
      instructions:
      - text: Publish asset {assetKey} revision {revision} to stage {environmentKey}.
        slots:
          assetKey: requestBody.assetKey
          revision: requestBody.revision
          environmentKey: requestBody.environmentKey
      - text: Start a {operation} publish operation for asset {assetKey}.
        slots:
          operation: requestBody.operation
          assetKey: requestBody.assetKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/publish-operations/{operationKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one publication
      effect: read
      questions:
      - How do I check the status of a single publication?
      - What does a publish operation lookup return by key?
      instructions:
      - text: Get publication {operationKey}.
        slots:
          operationKey: path.operationKey
      - text: Check whether publication {operationKey} has completed.
        slots:
          operationKey: path.operationKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/publish-operations/{operationKey}/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a publication's log messages
      effect: read
      questions:
      - Why did my publication fail, according to its log?
      - Can I page through the log messages of one publish operation?
      instructions:
      - text: Show the log messages for publication {operationKey}.
        slots:
          operationKey: path.operationKey
      - text: Get the first {limit} publish log entries of {operationKey}.
        slots:
          limit: query.limit
          operationKey: path.operationKey
      method: generated
      generated: '2026-10-01'