Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Distiller Authorization IP Access API

4 actions 4 updates phrasing extends openapi/adobe-suite-ip-access-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/security/ip-access'].get

$.paths['/security/ip-access'].put

$.paths['/security/ip-access'].delete

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 Data Distiller Authorization IP Access API
  version: 1.0.0
extends: openapi/adobe-suite-ip-access-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: 3
- target: $.paths['/security/ip-access'].get
  update:
    x-apievangelist-phrasing:
      intent: Get allowed IP ranges for a sandbox
      effect: read
      questions:
      - Which IP addresses are allowed to query data in my sandbox through Query Service?
      - Is there an IP allowlist configured for Data Distiller in this sandbox?
      instructions:
      - text: Show the allowed IP ranges for sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: List the IP allowlist for Query Service access in {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/security/ip-access'].put
  update:
    x-apievangelist-phrasing:
      intent: Set allowed IP ranges for a sandbox
      effect: write
      questions:
      - How do I restrict Query Service access to our office IP ranges?
      - Can I replace the sandbox IP allowlist with a new set of ranges?
      instructions:
      - text: Allow only IP ranges {ipRanges} in sandbox {sandbox}.
        slots:
          ipRanges: requestBody.ipRanges
          sandbox: header.x-sandbox-name
      - text: Set the Query Service IP allowlist for {sandbox} to {ipRanges}.
        slots:
          sandbox: header.x-sandbox-name
          ipRanges: requestBody.ipRanges
      method: generated
      generated: '2026-09-26'
- target: $.paths['/security/ip-access'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove all IP range restrictions for a sandbox
      effect: destructive
      questions:
      - How do I clear every IP restriction on a sandbox?
      - Can I delete the whole IP allowlist for Query Service?
      instructions:
      - text: Delete all configured IP ranges for sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Remove the IP allowlist from {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'