Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloud Manager IP Allowlist Binding API

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

$.info
$.paths['/api/program/{programId}/ipAllowlist/{ipAllowlistId}/binding/{ipAllowlistBindingId}'].get
$.paths['/api/program/{programId}/ipAllowlist/{ipAllowlistId}/binding/{ipAllowlistBindingId}'].delete
$.paths['/api/program/{programId}/ipAllowlist/{ipAllowlistId}/bindings'].get
$.paths['/api/program/{programId}/ipAllowlist/{ipAllowlistId}/bindings'].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 Cloud Manager IP Allowlist Binding API
  version: 1.0.0
extends: openapi/adobe-suite-ip-allowlist-binding-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['/api/program/{programId}/ipAllowlist/{ipAllowlistId}/binding/{ipAllowlistBindingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one IP allowlist binding
      effect: read
      questions:
      - How do I check which environment and tier a specific IP allowlist binding applies to?
      - What status is a particular allowlist binding in?
      instructions:
      - text: Show binding {ipAllowlistBindingId} of allowlist {ipAllowlistId} in program {programId}.
        slots:
          ipAllowlistBindingId: path.ipAllowlistBindingId
          ipAllowlistId: path.ipAllowlistId
          programId: path.programId
      - text: Get the status of allowlist binding {ipAllowlistBindingId} for {ipAllowlistId} in {programId}.
        slots:
          ipAllowlistBindingId: path.ipAllowlistBindingId
          ipAllowlistId: path.ipAllowlistId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/ipAllowlist/{ipAllowlistId}/binding/{ipAllowlistBindingId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an IP allowlist binding
      effect: destructive
      questions:
      - How do I unbind an IP allowlist from an environment?
      - Can I delete one allowlist binding without deleting the allowlist?
      instructions:
      - text: Delete binding {ipAllowlistBindingId} of allowlist {ipAllowlistId} in program {programId}.
        slots:
          ipAllowlistBindingId: path.ipAllowlistBindingId
          ipAllowlistId: path.ipAllowlistId
          programId: path.programId
      - text: Unbind allowlist {ipAllowlistId} binding {ipAllowlistBindingId} in {programId}.
        slots:
          ipAllowlistId: path.ipAllowlistId
          ipAllowlistBindingId: path.ipAllowlistBindingId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/ipAllowlist/{ipAllowlistId}/bindings'].get
  update:
    x-apievangelist-phrasing:
      intent: List an IP allowlist's bindings
      effect: read
      questions:
      - Which environments is an IP allowlist currently bound to?
      - Can I see all bindings for one allowlist in a program?
      instructions:
      - text: List bindings for allowlist {ipAllowlistId} in program {programId}.
        slots:
          ipAllowlistId: path.ipAllowlistId
          programId: path.programId
      - text: Show every environment allowlist {ipAllowlistId} is bound to in {programId}.
        slots:
          ipAllowlistId: path.ipAllowlistId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/ipAllowlist/{ipAllowlistId}/bindings'].post
  update:
    x-apievangelist-phrasing:
      intent: Bind an IP allowlist to an environment
      effect: write
      questions:
      - How do I apply an IP allowlist to an environment in Cloud Manager?
      - Can I bind an allowlist to just the author or publish tier?
      instructions:
      - text: Bind allowlist {ipAllowlistId} to environment {environmentId} in program {programId}.
        slots:
          ipAllowlistId: path.ipAllowlistId
          environmentId: requestBody.environmentId
          programId: path.programId
      - text: Apply allowlist {ipAllowlistId} to the {tier} tier of environment {environmentId} in {programId}.
        slots:
          ipAllowlistId: path.ipAllowlistId
          tier: requestBody.tier
          environmentId: requestBody.environmentId
          programId: path.programId
      method: generated
      generated: '2026-09-26'