Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Attribute Based Access Control Policies API

7 actions 7 updates phrasing extends openapi/adobe-suite-attribute-based-access-control-policies-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 7

$.info
$.paths['/administration/policies'].get
$.paths['/administration/policies'].post
$.paths['/administration/policies/{POLICY_ID}'].get
$.paths['/administration/policies/{POLICY_ID}'].put
$.paths['/administration/policies/{POLICY_ID}'].delete
$.paths['/administration/policies/{POLICY_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 Attribute Based Access Control Policies API
  version: 1.0.0
extends: openapi/adobe-suite-attribute-based-access-control-policies-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: 6
- target: $.paths['/administration/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List access control policies
      effect: read
      questions:
      - Which attribute-based access control policies exist in my organization?
      - Can I see every access policy defined for our Experience Platform org?
      instructions:
      - text: List all access control policies for org {org}.
        slots:
          org: header.x-gw-ims-org-id
      - text: Show me our organization's ABAC policies.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/administration/policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an access control policy
      effect: write
      questions:
      - How do I create a new attribute-based access policy with rules?
      - What do I need to define when setting up a new access policy?
      instructions:
      - text: Create an access policy named {name} with the rules {rules}.
        slots:
          name: requestBody.name
          rules: requestBody.rules
      - text: Add a new policy {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/administration/policies/{POLICY_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one access control policy
      effect: read
      questions:
      - How do I view the rules of one specific access policy?
      - What does a single ABAC policy contain when I look it up by ID?
      instructions:
      - text: Show access policy {policy}.
        slots:
          policy: path.POLICY_ID
      - text: Get the rules defined in policy {policy}.
        slots:
          policy: path.POLICY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/administration/policies/{POLICY_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an access control policy
      effect: write
      questions:
      - How do I overwrite an access policy with a complete new definition?
      - Can I replace all the rules of a policy in one full update?
      instructions:
      - text: Replace policy {policy} entirely with name {name} and rules {rules}.
        slots:
          policy: path.POLICY_ID
          name: requestBody.name
          rules: requestBody.rules
      - text: Overwrite the full definition of access policy {policy}.
        slots:
          policy: path.POLICY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/administration/policies/{POLICY_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an access control policy
      effect: destructive
      questions:
      - How do I delete an access policy we no longer use?
      - Can I permanently remove an ABAC policy from my org?
      instructions:
      - text: Delete access policy {policy}.
        slots:
          policy: path.POLICY_ID
      - text: Remove policy {policy} from our organization.
        slots:
          policy: path.POLICY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/administration/policies/{POLICY_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch individual policy properties
      effect: write
      questions:
      - Can I change just one property of an access policy without resending the whole thing?
      - Which JSON Patch operations can I apply to a policy?
      instructions:
      - text: Patch policy {policy} with a {op} at {path} setting it to {value}.
        slots:
          policy: path.POLICY_ID
          op: requestBody.op
          path: requestBody.path
          value: requestBody.value
      - text: Change only the {path} property of policy {policy} to {value}.
        slots:
          path: requestBody.path
          policy: path.POLICY_ID
          value: requestBody.value
      method: generated
      generated: '2026-09-26'