OutSystems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Environment Configurations Private gateways API

5 actions 5 updates phrasing extends openapi/outsystems-private-gateways-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['/environments/{environmentKey}/private-gateway/activation'].post
$.paths['/environments/{environmentKey}/private-gateway/deactivation'].post
$.paths['/environments/{environmentKey}/private-gateway'].get
$.paths['/environments/{environmentKey}/private-gateway/key-rotation'].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 Environment Configurations Private gateways API
  version: 1.0.0
extends: openapi/outsystems-private-gateways-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['/environments/{environmentKey}/private-gateway/activation'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a stage's private gateway
      effect: write
      questions:
      - How do I turn on the Private Gateway for a stage?
      - What permission is needed to activate a private gateway?
      instructions:
      - text: Activate the private gateway in stage {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      - text: Enable Private Gateway for environment {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/private-gateway/deactivation'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a stage's private gateway
      effect: destructive
      questions:
      - Can I switch off the Private Gateway for a stage?
      - How do I disable private network connectivity for an environment?
      instructions:
      - text: Deactivate the private gateway in stage {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      - text: Disable Private Gateway for environment {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/private-gateway'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stage's private gateway status
      effect: read
      questions:
      - Is the Private Gateway active in my stage?
      - Where can I check private gateway status for an environment?
      instructions:
      - text: Get the private gateway status of stage {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      - text: Check whether Private Gateway is on in {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/private-gateway/key-rotation'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a private gateway key
      effect: write
      questions:
      - How do I rotate the key used by my Private Gateway?
      - Can I generate a fresh private gateway key for a stage?
      instructions:
      - text: Rotate the private gateway key in stage {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      - text: Issue a new Private Gateway key for environment {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'