Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Prep Mapping sets API

9 actions 9 updates phrasing extends openapi/adobe-suite-mapping-sets-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['/mappingSets'].get
$.paths['/mappingSets'].post
$.paths['/mappingSets/validate'].post
$.paths['/mappingSets/preview'].post
$.paths['/mappingSets/{MAPPING_SET_ID}'].get
$.paths['/mappingSets/{MAPPING_SET_ID}'].put
$.paths['/mappingSets/{MAPPING_SET_ID}/mappings'].get
$.paths['/mappingSets/{MAPPING_SET_ID}/mappings/{MAPPING_ID}'].get

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 Data Prep Mapping sets API
  version: 1.0.0
extends: openapi/adobe-suite-mapping-sets-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['/mappingSets'].get
  update:
    x-apievangelist-phrasing:
      intent: List data prep mapping sets
      effect: read
      questions:
      - How do I list the mapping sets defined in my Experience Platform sandbox?
      - Can I filter mapping sets by name and sort by last updated?
      instructions:
      - text: List {limit} mapping sets starting at {start}.
        slots:
          limit: query.limit
          start: query.start
      - text: Find mapping sets named {name}, {limit} per page from {start}.
        slots:
          name: query.name
          limit: query.limit
          start: query.start
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mappingSets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a mapping set
      effect: write
      questions:
      - How do I create a new mapping set that maps source fields to an XDM schema?
      - Can a mapping set allow null values in its output?
      instructions:
      - text: Create a mapping set with mappings {mappings} to output schema {outputSchema}.
        slots:
          mappings: requestBody.mappings
          outputSchema: requestBody.outputSchema
      - text: Create mapping set {name} from input schema {inputSchema}.
        slots:
          name: requestBody.name
          inputSchema: requestBody.inputSchema
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mappingSets/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a mapping set before saving
      effect: read
      questions:
      - Can I check that my field mappings are valid without creating the mapping set?
      - How do I catch errors in a mapping set definition early?
      instructions:
      - text: Validate these mappings {mappings} against output schema {outputSchema}.
        slots:
          mappings: requestBody.mappings
          outputSchema: requestBody.outputSchema
      - text: Check whether my draft mapping set is valid.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mappingSets/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview mapping output on sample data
      effect: read
      questions:
      - How can I see what my mappings produce on sample data before using them?
      - Can I test a mapping set against a few records?
      instructions:
      - text: Preview mapping set {mappingSet} on sample data {data}.
        slots:
          mappingSet: requestBody.mappingSet
          data: requestBody.data
      - text: Show the transformed output of my mappings for these sample records.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mappingSets/{MAPPING_SET_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a mapping set
      effect: read
      questions:
      - How do I look up one mapping set by ID?
      - Can I retrieve an older version of a mapping set?
      instructions:
      - text: Show mapping set {MAPPING_SET_ID}.
        slots:
          MAPPING_SET_ID: path.MAPPING_SET_ID
      - text: Get version {version} of mapping set {MAPPING_SET_ID}.
        slots:
          version: query.version
          MAPPING_SET_ID: path.MAPPING_SET_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mappingSets/{MAPPING_SET_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a mapping set
      effect: write
      questions:
      - How do I change the mappings in an existing mapping set?
      - Does updating a mapping set create a new version?
      instructions:
      - text: Update mapping set {MAPPING_SET_ID} with mappings {mappings}.
        slots:
          MAPPING_SET_ID: path.MAPPING_SET_ID
          mappings: requestBody.mappings
      - text: Change the output schema of mapping set {MAPPING_SET_ID} to {outputSchema}.
        slots:
          MAPPING_SET_ID: path.MAPPING_SET_ID
          outputSchema: requestBody.outputSchema
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mappingSets/{MAPPING_SET_ID}/mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List the mappings in a mapping set
      effect: read
      questions:
      - How do I see every individual field mapping inside a mapping set?
      - Which source-to-target mappings does a given mapping set contain?
      instructions:
      - text: List the mappings in mapping set {MAPPING_SET_ID}.
        slots:
          MAPPING_SET_ID: path.MAPPING_SET_ID
      - text: Show all field mappings for {MAPPING_SET_ID}.
        slots:
          MAPPING_SET_ID: path.MAPPING_SET_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mappingSets/{MAPPING_SET_ID}/mappings/{MAPPING_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one mapping from a mapping set
      effect: read
      questions:
      - How do I look up a single field mapping within a mapping set?
      - Can I fetch one mapping by its ID?
      instructions:
      - text: Show mapping {MAPPING_ID} in mapping set {MAPPING_SET_ID}.
        slots:
          MAPPING_ID: path.MAPPING_ID
          MAPPING_SET_ID: path.MAPPING_SET_ID
      - text: Get field mapping {MAPPING_ID} from {MAPPING_SET_ID}.
        slots:
          MAPPING_ID: path.MAPPING_ID
          MAPPING_SET_ID: path.MAPPING_SET_ID
      method: generated
      generated: '2026-09-26'