OutSystems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Environment Configurations IP filters API

6 actions 6 updates phrasing extends openapi/outsystems-ip-filters-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 6

$.info

$.paths['/environments/{environmentKey}/ip-filter-groups/{ipFilterGroupKey}'].get

$.paths['/environments/{environmentKey}/ip-filter-groups/{ipFilterGroupKey}'].delete

$.paths['/environments/{environmentKey}/ip-filter-groups/{ipFilterGroupKey}'].patch

$.paths['/environments/{environmentKey}/ip-filter-groups'].get

$.paths['/environments/{environmentKey}/ip-filter-groups'].post

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 Environment Configurations IP filters API
  version: 1.0.0
extends: openapi/outsystems-ip-filters-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: 5
- target: $.paths['/environments/{environmentKey}/ip-filter-groups/{ipFilterGroupKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one IP filter group
      effect: read
      questions:
      - What IP rules are in a specific IP filter group?
      - Which apps does a given IP filter group protect?
      instructions:
      - text: Get IP filter group {ipFilterGroupKey} in stage {environmentKey}.
        slots:
          ipFilterGroupKey: path.ipFilterGroupKey
          environmentKey: path.environmentKey
      - text: Show the rules of IP filter group {ipFilterGroupKey} for environment {environmentKey}.
        slots:
          ipFilterGroupKey: path.ipFilterGroupKey
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/ip-filter-groups/{ipFilterGroupKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an IP filter group
      effect: destructive
      questions:
      - Can I remove an IP filter group from a stage?
      - What permission do I need to delete IP restrictions in ODC?
      instructions:
      - text: Delete IP filter group {ipFilterGroupKey} from stage {environmentKey}.
        slots:
          ipFilterGroupKey: path.ipFilterGroupKey
          environmentKey: path.environmentKey
      - text: Remove IP restrictions group {ipFilterGroupKey} in {environmentKey}.
        slots:
          ipFilterGroupKey: path.ipFilterGroupKey
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/ip-filter-groups/{ipFilterGroupKey}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an IP filter group
      effect: write
      questions:
      - How do I add new IP ranges to an existing IP filter group?
      - Can I change whether an IP filter group allows or blocks access?
      instructions:
      - text: Update the IP rules of group {ipFilterGroupKey} in stage {environmentKey} to {ipRules}.
        slots:
          ipFilterGroupKey: path.ipFilterGroupKey
          environmentKey: path.environmentKey
          ipRules: requestBody.ipRules
      - text: Change IP filter group {ipFilterGroupKey} in {environmentKey} to access type {accessType}.
        slots:
          ipFilterGroupKey: path.ipFilterGroupKey
          environmentKey: path.environmentKey
          accessType: requestBody.accessType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/ip-filter-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List IP filter groups in a stage
      effect: read
      questions:
      - What IP filter groups restrict access in my stage?
      - Can I see only the IP filters applied to particular apps?
      instructions:
      - text: List IP filter groups in stage {environmentKey}.
        slots:
          environmentKey: path.environmentKey
      - text: Show IP filter groups in {environmentKey} that apply to apps {appKeys}.
        slots:
          environmentKey: path.environmentKey
          appKeys: query.appKeys
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentKey}/ip-filter-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an IP filter group
      effect: write
      questions:
      - How do I restrict app access to certain IP addresses in a stage?
      - Can I create an IP filter group that applies only to specific apps?
      instructions:
      - text: Create IP filter group {name} in stage {environmentKey} with rules {ipRules}.
        slots:
          name: requestBody.name
          environmentKey: path.environmentKey
          ipRules: requestBody.ipRules
      - text: Create an IP filter in {environmentKey} named {name} for apps {appKeys}.
        slots:
          environmentKey: path.environmentKey
          name: requestBody.name
          appKeys: requestBody.appKeys
      method: generated
      generated: '2026-10-01'