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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Deployments Deployment Operations API
version: 1.0.0
extends: openapi/outsystems-deployment-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['/deployment-operations'].get
update:
x-apievangelist-phrasing:
intent: List deployments
effect: read
questions:
- Which deployments ran in a given stage recently?
- Can I filter deployments by status, asset or creation date?
- Can I see only the failed deployments for one portfolio?
instructions:
- text: List deployments in stage {environmentKey}.
slots:
environmentKey: query.environmentKey
- text: Show deployments of asset {assetKey} with status {status}.
slots:
assetKey: query.assetKey
status: query.status
- text: List deployments created since {createdDateSince}.
slots:
createdDateSince: query.createdDateSince
method: generated
generated: '2026-10-01'
- target: $.paths['/deployment-operations'].post
update:
x-apievangelist-phrasing:
intent: Deploy, undeploy or apply configs
effect: write
questions:
- How do I deploy an app revision to a stage through the API?
- Can I undeploy an asset from a stage, or only reapply its configurations?
instructions:
- text: Deploy asset {assetKey} revision {revision} to stage {environmentKey}.
slots:
assetKey: requestBody.assetKey
revision: requestBody.revision
environmentKey: requestBody.environmentKey
- text: Run a {operation} deployment operation for asset {assetKey} in stage {environmentKey}.
slots:
operation: requestBody.operation
assetKey: requestBody.assetKey
environmentKey: requestBody.environmentKey
method: generated
generated: '2026-10-01'
- target: $.paths['/deployment-operations/{operationKey}'].get
update:
x-apievangelist-phrasing:
intent: Get one deployment
effect: read
questions:
- How do I check the status of a single deployment by its key?
- What does a 404 mean when I look up a deployment operation?
instructions:
- text: Get deployment operation {operationKey}.
slots:
operationKey: path.operationKey
- text: Check whether deployment {operationKey} has succeeded.
slots:
operationKey: path.operationKey
method: generated
generated: '2026-10-01'
- target: $.paths['/deployment-operations/{operationKey}/messages'].get
update:
x-apievangelist-phrasing:
intent: Read a deployment's log messages
effect: read
questions:
- Why did my deployment fail, according to its log?
- Can I page through the log messages of one deployment?
instructions:
- text: Show the log messages for deployment {operationKey}.
slots:
operationKey: path.operationKey
- text: Get the first {limit} deployment log entries of {operationKey}.
slots:
limit: query.limit
operationKey: path.operationKey
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.