Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Real-time Customer Profile Merge policies API

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

$.info
$.paths['/ups/config/mergePolicies'].get
$.paths['/ups/config/mergePolicies'].post
$.paths['/ups/config/mergePolicies/{mergePolicyId}'].get
$.paths['/ups/config/mergePolicies/{mergePolicyId}'].put
$.paths['/ups/config/mergePolicies/{mergePolicyId}'].delete
$.paths['/ups/config/mergePolicies/{mergePolicyId}'].patch
$.paths['/ups/config/mergePolicies/bulk-get'].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 Real-time Customer Profile Merge policies API
  version: 1.0.0
extends: openapi/adobe-suite-merge-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: 7
- target: $.paths['/ups/config/mergePolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List merge policies
      effect: read
      questions:
      - Which merge policies exist for our Real-Time Customer Profile data?
      - Can I list only the default merge policy for a given schema class?
      - How are merge policies paged and sorted when listed?
      instructions:
      - text: List merge policies in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show merge policies for schema {schemaName} where default is {default}.
        slots:
          schemaName: query.schema.name
          default: query.default
      - text: List {limit} merge policies ordered by {orderby}.
        slots:
          limit: query.limit
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ups/config/mergePolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a merge policy
      effect: write
      questions:
      - How do I create a merge policy that decides how profile fragments are combined?
      - Can a new merge policy be made the default and active on edge?
      instructions:
      - text: Create merge policy {name} for schema {schema} using identity graph {identityGraph} and attribute merge {attributeMerge}.
        slots:
          name: requestBody.name
          schema: requestBody.schema
          identityGraph: requestBody.identityGraph
          attributeMerge: requestBody.attributeMerge
      - text: Add a merge policy for {schema} with {attributeMerge}, graph {identityGraph}, and set default to {default}.
        slots:
          schema: requestBody.schema
          attributeMerge: requestBody.attributeMerge
          identityGraph: requestBody.identityGraph
          default: requestBody.default
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ups/config/mergePolicies/{mergePolicyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one merge policy
      effect: read
      questions:
      - What identity graph and attribute merge rules does a specific merge policy use?
      - How do I view one merge policy by its ID?
      instructions:
      - text: Show me merge policy {mergePolicyId}.
        slots:
          mergePolicyId: path.mergePolicyId
      - text: Get merge policy {mergePolicyId} from sandbox {sandbox}.
        slots:
          mergePolicyId: path.mergePolicyId
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ups/config/mergePolicies/{mergePolicyId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a merge policy
      effect: write
      questions:
      - Can I overwrite an entire merge policy with a new definition?
      - What must I resend when fully replacing a merge policy?
      instructions:
      - text: Replace merge policy {mergePolicyId} with schema {schema}, identity graph {identityGraph} and attribute merge {attributeMerge}.
        slots:
          mergePolicyId: path.mergePolicyId
          schema: requestBody.schema
          identityGraph: requestBody.identityGraph
          attributeMerge: requestBody.attributeMerge
      - text: Rewrite merge policy {mergePolicyId} and set isActiveOnEdge to {isActiveOnEdge}.
        slots:
          mergePolicyId: path.mergePolicyId
          isActiveOnEdge: requestBody.isActiveOnEdge
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ups/config/mergePolicies/{mergePolicyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a merge policy
      effect: destructive
      questions:
      - How do I delete a merge policy we no longer use?
      - Can I remove a merge policy from a specific sandbox?
      instructions:
      - text: Delete merge policy {mergePolicyId}.
        slots:
          mergePolicyId: path.mergePolicyId
      - text: Remove merge policy {mergePolicyId} from sandbox {sandbox}.
        slots:
          mergePolicyId: path.mergePolicyId
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ups/config/mergePolicies/{mergePolicyId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change individual fields on a merge policy
      effect: write
      questions:
      - Can I change just one attribute of a merge policy without replacing it?
      - Is there a partial update for merge policies?
      instructions:
      - text: Patch merge policy {mergePolicyId} with the attribute changes I give you.
        slots:
          mergePolicyId: path.mergePolicyId
      - text: Partially update merge policy {mergePolicyId} in sandbox {sandbox}.
        slots:
          mergePolicyId: path.mergePolicyId
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ups/config/mergePolicies/bulk-get'].post
  update:
    x-apievangelist-phrasing:
      intent: Get several merge policies by ID
      effect: read
      questions:
      - Can I fetch several merge policies at once by passing their IDs?
      - What's the batch lookup for merge policies?
      instructions:
      - text: Fetch merge policies {ids} in one request.
        slots:
          ids: requestBody.ids
      - text: Bulk-get the merge policies {ids} from sandbox {sandbox}.
        slots:
          ids: requestBody.ids
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'