OutSystems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Outsystems Environments API

15 actions 15 updates phrasing extends openapi/outsystems-environments-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 15

$.info

$.paths['/environments/{environmentKey}/agents/{agentKey}/revisions/deployed/configurations'].get

$.paths['/environments/{environmentKey}/agents/{agentKey}/revisions/{baselineRevision}/configurations'].get

$.paths['/environments/{environmentKey}/applications/{applicationKey}/revisions/deployed/configurations'].get

$.paths['/environments/{environmentKey}/applications/{applicationKey}/revisions/{baselineRevision}/configurations'].get

$.paths['/environments/{environmentKey}/agents/{agentKey}/configurations'].patch

$.paths['/environments/{environmentKey}/applications/{applicationKey}/configurations'].patch

$.paths['/environments/{environmentKey}/default-system-configurations'].get

$.paths['/environments/{environmentKey}/default-system-configurations'].patch

$.paths['/environments'].get

$.paths['/environments'].patch

$.paths['/environments/{environmentKey}'].patch

$.paths['/environments/{environmentKey}/entitlements/usage/by-asset'].get

$.paths['/environments/{environmentKey}/entitlements'].get

$.paths['/environments/{environmentKey}/entitlements/usage'].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 Outsystems Environments API
  version: 1.0.0
extends: openapi/outsystems-environments-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: 14
- target: $.paths['/environments/{environmentKey}/agents/{agentKey}/revisions/deployed/configurations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployed agent's configurations
      effect: read
      questions:
      - What settings and timers is my deployed agent currently running with?
      - Can I see binary configuration values for an agent in a stage?
      instructions:
      - text: Get the deployed configurations of agent {agentKey} in stage {environmentKey}.
        slots:
          agentKey: path.agentKey
          environmentKey: path.environmentKey
      - text: Show the live settings of agent {agentKey} in environment {environmentKey}.
        slots:
          agentKey: path.agentKey
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/agents/{agentKey}/revisions/{baselineRevision}/configurations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get configurations of an agent revision
      effect: read
      questions:
      - How do I see the configurations for a specific revision of an agent, not the deployed one?
      - Can I compare an agent revision's settings before I deploy it?
      instructions:
      - text: Get configurations of agent {agentKey} revision {baselineRevision} in stage {environmentKey}.
        slots:
          agentKey: path.agentKey
          baselineRevision: path.baselineRevision
          environmentKey: path.environmentKey
      - text: Show the settings agent {agentKey} would use at revision {baselineRevision} in {environmentKey}.
        slots:
          agentKey: path.agentKey
          baselineRevision: path.baselineRevision
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/applications/{applicationKey}/revisions/deployed/configurations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployed app's configurations
      effect: read
      questions:
      - What site settings and integrations is my deployed app using in a stage?
      - Can I read the live configuration values of an app in production?
      instructions:
      - text: Get the deployed configurations of app {applicationKey} in stage {environmentKey}.
        slots:
          applicationKey: path.applicationKey
          environmentKey: path.environmentKey
      - text: Show the live settings of app {applicationKey} in environment {environmentKey}.
        slots:
          applicationKey: path.applicationKey
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/applications/{applicationKey}/revisions/{baselineRevision}/configurations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get configurations of an app revision
      effect: read
      questions:
      - How do I see an app's configurations for a revision that isn't deployed yet?
      - Which settings does a given app revision define in a stage?
      instructions:
      - text: Get configurations of app {applicationKey} revision {baselineRevision} in stage {environmentKey}.
        slots:
          applicationKey: path.applicationKey
          baselineRevision: path.baselineRevision
          environmentKey: path.environmentKey
      - text: Show what settings app {applicationKey} has at revision {baselineRevision} in {environmentKey}.
        slots:
          applicationKey: path.applicationKey
          baselineRevision: path.baselineRevision
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/agents/{agentKey}/configurations'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an agent's configurations
      effect: write
      questions:
      - How do I change settings or timers for an agent in a stage?
      - Does updating an agent's configuration change only the values I send?
      instructions:
      - text: Update the settings of agent {agentKey} in stage {environmentKey} to {settings}.
        slots:
          agentKey: path.agentKey
          environmentKey: path.environmentKey
          settings: requestBody.settings
      - text: Change the timers of agent {agentKey} in {environmentKey} to {timers}.
        slots:
          agentKey: path.agentKey
          environmentKey: path.environmentKey
          timers: requestBody.timers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/applications/{applicationKey}/configurations'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an app's configurations
      effect: write
      questions:
      - How do I change an app's settings or integration endpoints in one stage?
      - Can I override system configurations for a single app?
      instructions:
      - text: Update the settings of app {applicationKey} in stage {environmentKey} to {settings}.
        slots:
          applicationKey: path.applicationKey
          environmentKey: path.environmentKey
          settings: requestBody.settings
      - text: Change the integrations of app {applicationKey} in {environmentKey} to {integrations}.
        slots:
          applicationKey: path.applicationKey
          environmentKey: path.environmentKey
          integrations: requestBody.integrations
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/default-system-configurations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stage's default system configurations
      effect: read
      questions:
      - What default system configurations apply to every app in a stage?
      - Where can I see a stage's baseline system settings?
      instructions:
      - text: Get the default system configurations of stage {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      - text: Show environment {environmentKey}'s default system settings.
        slots:
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/default-system-configurations'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a stage's default system configurations
      effect: write
      questions:
      - How do I change the default system configurations for a whole stage?
      - Are omitted default system settings left unchanged when I update a stage?
      instructions:
      - text: Update the default system configurations of stage {environmentKey} to {systemConfigurations}.
        slots:
          environmentKey: path.environmentKey
          systemConfigurations: requestBody.systemConfigurations
      - text: Set environment {environmentKey}'s stage-wide system defaults to {systemConfigurations}.
        slots:
          environmentKey: path.environmentKey
          systemConfigurations: requestBody.systemConfigurations
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments (stages)
      effect: read
      questions:
      - What stages, like Development, QA and Production, do I have in ODC?
      - Can I list only the stages that belong to one portfolio?
      instructions:
      - text: List all my environments.
      - text: List the stages in portfolio {portfolioKey}.
        slots:
          portfolioKey: query.portfolioKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or reorder several stages
      effect: write
      questions:
      - Can I rename and reorder multiple stages in one request?
      - What permission do I need to change the order of my stages?
      instructions:
      - text: 'Update these stages'' names and order: {environments}.'
        slots:
          environments: requestBody.environments
      - text: Reorder all my stages as {environments}.
        slots:
          environments: requestBody.environments
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or reposition one stage
      effect: write
      questions:
      - How do I rename a single stage?
      - Can I move one stage to a different position in the pipeline order?
      instructions:
      - text: Rename stage {environmentKey} to {name}.
        slots:
          environmentKey: path.environmentKey
          name: requestBody.name
      - text: Move stage {environmentKey} to position {order}.
        slots:
          environmentKey: path.environmentKey
          order: requestBody.order
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/entitlements/usage/by-asset'].get
  update:
    x-apievangelist-phrasing:
      intent: Get entitlement usage per asset in a stage
      effect: read
      questions:
      - Which apps or libraries consume the most of my entitlements in a stage?
      - Can I break a stage's usage down by asset and sort by a metric?
      instructions:
      - text: Show entitlement usage per asset in stage {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      - text: Get usage by asset in {environmentKey} for entitlements {entitlementIds} since {since}.
        slots:
          environmentKey: path.environmentKey
          entitlementIds: query.entitlementIds
          since: query.since
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/entitlements'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stage's entitlements
      effect: read
      questions:
      - What entitlements and add-ons does a specific stage have?
      - Which limits apply to one environment under my subscription?
      instructions:
      - text: Get the entitlements of stage {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      - text: Show the add-ons and entitlements for environment {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/entitlements/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get entitlement usage for a stage
      effect: read
      questions:
      - How much of its entitlements has a stage used over a date range?
      - Can I see a stage's usage aggregated daily or monthly?
      instructions:
      - text: Show entitlement usage for stage {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      - text: Get usage for {environmentKey} between {since} and {to} at {granularity} granularity.
        slots:
          environmentKey: path.environmentKey
          since: query.since
          to: query.to
          granularity: query.granularity
      method: generated
      generated: '2026-10-01'