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 Dependency Management Deployment Analyses API
version: 1.0.0
extends: openapi/outsystems-deployment-analyses-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: 2
- target: $.paths['/deployment-analyses/{analysisKey}'].get
update:
x-apievangelist-phrasing:
intent: Get a deployment impact report
effect: read
questions:
- Is the deployment analysis finished, and what impacts did it find?
- How do I read the result of a pre-deployment analysis?
instructions:
- text: Get the result of deployment analysis {analysisKey}.
slots:
analysisKey: path.analysisKey
- text: Show the deployment impact report for {analysisKey}.
slots:
analysisKey: path.analysisKey
method: generated
generated: '2026-10-01'
- target: $.paths['/deployment-analyses'].post
update:
x-apievangelist-phrasing:
intent: Analyze the impact of promoting an asset
effect: read
questions:
- Before promoting an app to another stage, can I check the impact on its consumers?
- Will promoting this revision conflict with the producers it depends on?
instructions:
- text: Launch a deployment analysis for asset {assetKey} revision {revision} to stage {environmentKey}.
slots:
assetKey: requestBody.assetKey
revision: requestBody.revision
environmentKey: requestBody.environmentKey
- text: Check the impact of promoting {assetKey} to stage {environmentKey}.
slots:
assetKey: requestBody.assetKey
environmentKey: requestBody.environmentKey
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.