Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Policy Service Policy evaluation API

6 actions 6 updates phrasing extends openapi/adobe-suite-policy-evaluation-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['/marketingActions/core/{MARKETING_ACTION_NAME}/constraints'].get
$.paths['/marketingActions/core/{MARKETING_ACTION_NAME}/constraints'].post
$.paths['/marketingActions/custom/{MARKETING_ACTION_NAME}/constraints'].get
$.paths['/marketingActions/custom/{MARKETING_ACTION_NAME}/constraints'].post
$.paths['/bulk-eval'].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 Policy Service Policy evaluation API
  version: 1.0.0
extends: openapi/adobe-suite-policy-evaluation-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['/marketingActions/core/{MARKETING_ACTION_NAME}/constraints'].get
  update:
    x-apievangelist-phrasing:
      intent: Test a core marketing action against labels
      effect: read
      questions:
      - Would a core marketing action violate policy on data carrying certain usage labels?
      - Can I include draft policies when checking a core marketing action against labels?
      instructions:
      - text: Evaluate core marketing action {MARKETING_ACTION_NAME} against labels {duleLabels}.
        slots:
          MARKETING_ACTION_NAME: path.MARKETING_ACTION_NAME
          duleLabels: query.duleLabels
      - text: 'Check core action {MARKETING_ACTION_NAME} on labels {duleLabels}, including drafts: {includeDraft}.'
        slots:
          MARKETING_ACTION_NAME: path.MARKETING_ACTION_NAME
          duleLabels: query.duleLabels
          includeDraft: query.includeDraft
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketingActions/core/{MARKETING_ACTION_NAME}/constraints'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a core marketing action against datasets
      effect: read
      questions:
      - Can I use a core marketing action on these actual datasets or fields without breaking a policy?
      - What constraints apply to a core marketing action on an existing dataset?
      instructions:
      - text: Evaluate core marketing action {MARKETING_ACTION_NAME} against the datasets and fields I list.
        slots:
          MARKETING_ACTION_NAME: path.MARKETING_ACTION_NAME
      - text: Check core action {MARKETING_ACTION_NAME} on my datasets with draft policies {includeDraft}.
        slots:
          MARKETING_ACTION_NAME: path.MARKETING_ACTION_NAME
          includeDraft: query.includeDraft
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketingActions/custom/{MARKETING_ACTION_NAME}/constraints'].get
  update:
    x-apievangelist-phrasing:
      intent: Test a custom marketing action against labels
      effect: read
      questions:
      - Does a marketing action my org defined itself conflict with data usage labels?
      - Which policy constraints hit a custom action on hypothetical labeled data?
      instructions:
      - text: Evaluate custom marketing action {MARKETING_ACTION_NAME} against labels {duleLabels}.
        slots:
          MARKETING_ACTION_NAME: path.MARKETING_ACTION_NAME
          duleLabels: query.duleLabels
      - text: Check our custom action {MARKETING_ACTION_NAME} with labels {duleLabels}, draft policies {includeDraft}.
        slots:
          MARKETING_ACTION_NAME: path.MARKETING_ACTION_NAME
          duleLabels: query.duleLabels
          includeDraft: query.includeDraft
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketingActions/custom/{MARKETING_ACTION_NAME}/constraints'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a custom marketing action against datasets
      effect: read
      questions:
      - Can our own custom marketing action run on a specific dataset without a policy violation?
      - How do I check a custom action against real datasets and fields?
      instructions:
      - text: Evaluate custom marketing action {MARKETING_ACTION_NAME} against the datasets I name.
        slots:
          MARKETING_ACTION_NAME: path.MARKETING_ACTION_NAME
      - text: Check our custom action {MARKETING_ACTION_NAME} on these dataset fields, draft policies {includeDraft}.
        slots:
          MARKETING_ACTION_NAME: path.MARKETING_ACTION_NAME
          includeDraft: query.includeDraft
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk-eval'].post
  update:
    x-apievangelist-phrasing:
      intent: Run many policy evaluations in one call
      effect: read
      questions:
      - Can I evaluate several marketing actions against data usage policies in a single request?
      - Is there a bulk way to run policy checks instead of calling each action's constraints?
      instructions:
      - text: Run a bulk policy evaluation for the marketing actions and data I list.
      - text: Evaluate all of these policy checks together in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'