Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Policy Service Policies API

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

$.info
$.paths['/policies/core'].get
$.paths['/policies/core/{POLICY_ID}'].get
$.paths['/policies/custom'].get
$.paths['/policies/custom'].post
$.paths['/policies/custom/{POLICY_ID}'].get
$.paths['/policies/custom/{POLICY_ID}'].put
$.paths['/policies/custom/{POLICY_ID}'].delete
$.paths['/policies/custom/{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 Policy Service Policies API
  version: 1.0.0
extends: openapi/adobe-suite-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: 8
- target: $.paths['/policies/core'].get
  update:
    x-apievangelist-phrasing:
      intent: List Adobe-defined core data usage policies
      effect: read
      questions:
      - Which built-in data governance policies does Adobe Experience Platform ship with?
      - Can I filter the core policies to those tied to a specific marketing action?
      - Which core policies apply to data carrying a given DULE label?
      instructions:
      - text: List the core data usage policies in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show core policies that restrict marketing action {marketingAction}.
        slots:
          marketingAction: query.marketingAction
      - text: List core policies covering labels {duleLabels}, limited to {limit} results.
        slots:
          duleLabels: query.duleLabels
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policies/core/{POLICY_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one core data usage policy
      effect: read
      questions:
      - What exactly does a particular Adobe core policy deny?
      - How do I read the details of one core governance policy by its ID?
      instructions:
      - text: Show me core policy {POLICY_ID}.
        slots:
          POLICY_ID: path.POLICY_ID
      - text: Get core policy {POLICY_ID} from sandbox {sandbox}.
        slots:
          POLICY_ID: path.POLICY_ID
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policies/custom'].get
  update:
    x-apievangelist-phrasing:
      intent: List our custom data usage policies
      effect: read
      questions:
      - Which custom governance policies has our organization defined?
      - Can I sort or page through our custom data usage policies?
      - Do any of our custom policies block a given marketing action?
      instructions:
      - text: List our custom data usage policies in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show custom policies that restrict marketing action {marketingAction}.
        slots:
          marketingAction: query.marketingAction
      - text: List custom policies ordered by {orderby}, starting at {start}.
        slots:
          orderby: query.orderby
          start: query.start
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policies/custom'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom data usage policy
      effect: write
      questions:
      - How do I create my own data usage policy that denies a marketing action on labeled data?
      - Can a new custom policy start out as a draft instead of enabled?
      instructions:
      - text: Create a custom policy named {name} that denies {deny} for marketing action {marketingActionRefs}.
        slots:
          name: requestBody.name
          deny: requestBody.deny
          marketingActionRefs: requestBody.marketingActionRefs
      - text: Add custom policy {name} with status {status} and description {description}.
        slots:
          name: requestBody.name
          status: requestBody.status
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policies/custom/{POLICY_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom data usage policy
      effect: read
      questions:
      - How do I view the rules of one of our custom policies?
      - What status and marketing actions does a given custom policy have?
      instructions:
      - text: Show me custom policy {POLICY_ID}.
        slots:
          POLICY_ID: path.POLICY_ID
      - text: Get our custom policy {POLICY_ID} in sandbox {sandbox}.
        slots:
          POLICY_ID: path.POLICY_ID
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policies/custom/{POLICY_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a custom data usage policy
      effect: write
      questions:
      - Can I overwrite a custom policy with a completely new definition?
      - What fields must I resend when fully replacing a custom policy?
      instructions:
      - text: Replace custom policy {POLICY_ID} with name {name} and deny rule {deny}.
        slots:
          POLICY_ID: path.POLICY_ID
          name: requestBody.name
          deny: requestBody.deny
      - text: Rewrite custom policy {POLICY_ID} to target marketing action {marketingActionRefs} with status {status}.
        slots:
          POLICY_ID: path.POLICY_ID
          marketingActionRefs: requestBody.marketingActionRefs
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policies/custom/{POLICY_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom data usage policy
      effect: destructive
      questions:
      - How do I delete a custom governance policy we no longer need?
      - Can a deleted custom policy be recovered?
      instructions:
      - text: Delete custom policy {POLICY_ID}.
        slots:
          POLICY_ID: path.POLICY_ID
      - text: Remove custom policy {POLICY_ID} from sandbox {sandbox}.
        slots:
          POLICY_ID: path.POLICY_ID
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policies/custom/{POLICY_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change individual fields on a custom policy
      effect: write
      questions:
      - Can I just flip a custom policy's status to enabled without resending the whole thing?
      - Is there a JSON Patch way to change one attribute of a custom policy?
      instructions:
      - text: 'Patch custom policy {POLICY_ID}: {op} {path} to {value}.'
        slots:
          POLICY_ID: path.POLICY_ID
          op: requestBody.op
          path: requestBody.path
          value: requestBody.value
      - text: Set only the field {path} on custom policy {POLICY_ID} using operation {op}.
        slots:
          path: requestBody.path
          POLICY_ID: path.POLICY_ID
          op: requestBody.op
      method: generated
      generated: '2026-09-26'