Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloud Manager IP Allowlist API

6 actions 6 updates phrasing extends openapi/adobe-suite-ip-allowlist-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 6

$.info

$.paths['/api/program/{programId}/ipAllowlist/{ipAllowlistId}'].get

$.paths['/api/program/{programId}/ipAllowlist/{ipAllowlistId}'].put

$.paths['/api/program/{programId}/ipAllowlist/{ipAllowlistId}'].delete

$.paths['/api/program/{programId}/ipAllowlists'].get

$.paths['/api/program/{programId}/ipAllowlists'].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 Cloud Manager IP Allowlist API
  version: 1.0.0
extends: openapi/adobe-suite-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: 5
- target: $.paths['/api/program/{programId}/ipAllowlist/{ipAllowlistId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an IP allowlist
      effect: read
      questions:
      - How do I see the IP ranges in one of my Cloud Manager allowlists?
      - Can I look up a specific IP allowlist within a program?
      instructions:
      - text: Show IP allowlist {ipAllowlistId} in program {programId}.
        slots:
          ipAllowlistId: path.ipAllowlistId
          programId: path.programId
      - text: Get the CIDR ranges of allowlist {ipAllowlistId} for program {programId}.
        slots:
          ipAllowlistId: path.ipAllowlistId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/ipAllowlist/{ipAllowlistId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an IP allowlist
      effect: write
      questions:
      - Can I change the IP ranges or name of an existing allowlist?
      - How do I add a new CIDR block to an allowlist I already have?
      instructions:
      - text: Update allowlist {ipAllowlistId} in program {programId} to name {name} with ranges {ipCidrSet}.
        slots:
          ipAllowlistId: path.ipAllowlistId
          programId: path.programId
          name: requestBody.name
          ipCidrSet: requestBody.ipCidrSet
      - text: Replace the CIDR set of IP allowlist {ipAllowlistId} in program {programId} with {ipCidrSet}, keeping name {name}.
        slots:
          ipAllowlistId: path.ipAllowlistId
          programId: path.programId
          ipCidrSet: requestBody.ipCidrSet
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/ipAllowlist/{ipAllowlistId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an IP allowlist
      effect: destructive
      questions:
      - How do I remove an IP allowlist from a program?
      - Can an allowlist be deleted once it's no longer needed?
      instructions:
      - text: Delete IP allowlist {ipAllowlistId} from program {programId}.
        slots:
          ipAllowlistId: path.ipAllowlistId
          programId: path.programId
      - text: Remove allowlist {ipAllowlistId} in program {programId}.
        slots:
          ipAllowlistId: path.ipAllowlistId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/ipAllowlists'].get
  update:
    x-apievangelist-phrasing:
      intent: List a program's IP allowlists
      effect: read
      questions:
      - Which IP allowlists are defined for my program?
      - What allowlists exist across a Cloud Manager program?
      instructions:
      - text: List the IP allowlists for program {programId}.
        slots:
          programId: path.programId
      - text: Show every allowlist defined in program {programId}.
        slots:
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/ipAllowlists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an IP allowlist
      effect: write
      questions:
      - How do I restrict access to a program to certain IP addresses?
      - What's needed to set up a new IP allowlist?
      instructions:
      - text: Create IP allowlist {name} in program {programId} with ranges {ipCidrSet}.
        slots:
          name: requestBody.name
          programId: path.programId
          ipCidrSet: requestBody.ipCidrSet
      - text: Add a new allowlist called {name} to program {programId} for CIDR blocks {ipCidrSet}.
        slots:
          name: requestBody.name
          programId: path.programId
          ipCidrSet: requestBody.ipCidrSet
      method: generated
      generated: '2026-09-26'