ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dex IP Allowlist API

5 actions 5 updates phrasing extends openapi/controlup-ip-allowlist-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for ControlUp's API. It is a proposal applied on top of the contract, not a document ControlUp publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/organizations/{orgId}/ip-allowlist'].get
$.paths['/organizations/{orgId}/ip-allowlist'].post
$.paths['/organizations/{orgId}/ip-allowlist/{id}'].delete
$.paths['/organizations/{orgId}/ip-allowlist/{id}'].patch

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 Dex IP Allowlist API
  version: 1.0.0
extends: openapi/controlup-ip-allowlist-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/organizations/{orgId}/ip-allowlist'].get
  update:
    x-apievangelist-phrasing:
      intent: List IP allowlist entries
      effect: read
      questions:
      - Which IP addresses and ranges are allowed to access my organization?
      - Can I search allowlist entries by description?
      instructions:
      - text: List the IP allowlist entries for organization {orgId}.
        slots:
          orgId: path.orgId
      - text: Find allowlist entries in {orgId} described as {description}.
        slots:
          description: query.description
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/ip-allowlist'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an IP allowlist entry
      effect: write
      questions:
      - How do I allow a new office IP range to access ControlUp?
      - Can one allowlist entry hold several IP addresses or ranges?
      instructions:
      - text: Add an IP allowlist entry to {orgId} allowing {allowlist}.
        slots:
          allowlist: requestBody.allowlist
          orgId: path.orgId
      - text: Create allowlist entry {description} in {orgId} for {allowlist}.
        slots:
          allowlist: requestBody.allowlist
          description: requestBody.description
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/ip-allowlist/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an IP allowlist entry
      effect: destructive
      questions:
      - How do I remove an IP range from the allowlist?
      - Why can't I delete the first allowlist entry that was added automatically?
      instructions:
      - text: Delete IP allowlist entry {id} from organization {orgId}.
        slots:
          id: path.id
          orgId: path.orgId
      - text: Remove allowlist entry {id} in {orgId}.
        slots:
          id: path.id
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/ip-allowlist/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Replace the IPs in an allowlist entry
      effect: write
      questions:
      - How do I change the IP ranges in an existing allowlist entry?
      - Does updating an allowlist entry overwrite all of its addresses?
      instructions:
      - text: Overwrite allowlist entry {id} in {orgId} with addresses {allowlist}.
        slots:
          allowlist: requestBody.allowlist
          id: path.id
          orgId: path.orgId
      - text: Rename allowlist entry {id} in {orgId} to {description}.
        slots:
          description: requestBody.description
          id: path.id
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'