Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Repair Datarepair API

6 actions 6 updates phrasing extends openapi/adobe-suite-datarepair-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['/{globalCompanyId}/datarepair/v1/{reportSuiteId}/auth'].get

$.paths['/{globalCompanyId}/datarepair/v1/{reportSuiteId}/job'].get

$.paths['/{globalCompanyId}/datarepair/v1/{reportSuiteId}/job'].post

$.paths['/{globalCompanyId}/datarepair/v1/{reportSuiteId}/job/{jobId}'].get

$.paths['/{globalCompanyId}/datarepair/v1/{reportSuiteId}/serverCallEstimate'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Data Repair Datarepair API
  version: 1.0.0
extends: openapi/adobe-suite-datarepair-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['/{globalCompanyId}/datarepair/v1/{reportSuiteId}/auth'].get
  update:
    x-apievangelist-phrasing:
      intent: Check data repair authorization for a report suite
      effect: read
      questions:
      - Am I authorized to run a data repair on a given report suite?
      - Where do I get the validation token needed to start a data repair job?
      instructions:
      - text: Check data repair access for report suite {reportSuiteId} in {globalCompanyId}.
        slots:
          reportSuiteId: path.reportSuiteId
          globalCompanyId: path.globalCompanyId
      - text: Get a data repair auth token for {reportSuiteId}.
        slots:
          reportSuiteId: path.reportSuiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/datarepair/v1/{reportSuiteId}/job'].get
  update:
    x-apievangelist-phrasing:
      intent: List data repair jobs for a report suite
      effect: read
      questions:
      - What data repair jobs have been run on my report suite?
      - Can I see all repair jobs for one report suite at once?
      instructions:
      - text: List data repair jobs for report suite {reportSuiteId} in {globalCompanyId}.
        slots:
          reportSuiteId: path.reportSuiteId
          globalCompanyId: path.globalCompanyId
      - text: Show every repair job on {reportSuiteId}.
        slots:
          reportSuiteId: path.reportSuiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/datarepair/v1/{reportSuiteId}/job'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a data repair job
      effect: destructive
      questions:
      - How do I repair or delete variable data in Analytics for a date range?
      - Can I do a validate-only run before actually changing historical data?
      instructions:
      - text: Start a data repair in {globalCompanyId} on {reportSuiteId} from {dateRangeStart} to {dateRangeEnd} with token {validationToken}.
        slots:
          reportSuiteId: path.reportSuiteId
          dateRangeStart: query.dateRangeStart
          dateRangeEnd: query.dateRangeEnd
          validationToken: query.validationToken
          globalCompanyId: path.globalCompanyId
      - text: Dry-run a repair of {variables} on {reportSuiteId} with validateOnly {validateOnly}, token {validationToken}, {dateRangeStart} to {dateRangeEnd}.
        slots:
          variables: requestBody.variables
          reportSuiteId: path.reportSuiteId
          validateOnly: query.validateOnly
          validationToken: query.validationToken
          dateRangeStart: query.dateRangeStart
          dateRangeEnd: query.dateRangeEnd
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/datarepair/v1/{reportSuiteId}/job/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of one data repair job
      effect: read
      questions:
      - Has my data repair job finished yet?
      - Can I look up the progress of one specific repair job?
      instructions:
      - text: Show data repair job {jobId} on report suite {reportSuiteId}.
        slots:
          jobId: path.jobId
          reportSuiteId: path.reportSuiteId
      - text: Get the status of repair job {jobId} in {globalCompanyId} for {reportSuiteId}.
        slots:
          jobId: path.jobId
          globalCompanyId: path.globalCompanyId
          reportSuiteId: path.reportSuiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/datarepair/v1/{reportSuiteId}/serverCallEstimate'].get
  update:
    x-apievangelist-phrasing:
      intent: Estimate server calls for a data repair
      effect: read
      questions:
      - How many server calls would a data repair over a date range cost?
      - Can I estimate repair volume before I start the job?
      instructions:
      - text: Estimate server calls for {reportSuiteId} from {dateRangeStart} to {dateRangeEnd}.
        slots:
          reportSuiteId: path.reportSuiteId
          dateRangeStart: query.dateRangeStart
          dateRangeEnd: query.dateRangeEnd
      - text: Get the server call estimate in {globalCompanyId} for {reportSuiteId} between {dateRangeStart} and {dateRangeEnd}.
        slots:
          globalCompanyId: path.globalCompanyId
          reportSuiteId: path.reportSuiteId
          dateRangeStart: query.dateRangeStart
          dateRangeEnd: query.dateRangeEnd
      method: generated
      generated: '2026-09-26'