API Evangelist conversational phrasing for Data Use Governance - Data Discovery Worker Node Custom…

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Data Use Governance - Data Discovery Worker Node Custom…
  version: 1.0.0
extends: openapi/onetrust-custom-scan-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: 4
- target: $.paths['/v1/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List pending custom connector scan jobs
      effect: read
      questions:
      - Which custom connector scan jobs are pending for a data source?
      - Can my connector poll for scan work to do?
      instructions:
      - text: List pending scan jobs for data source {datasourceId}.
        slots:
          datasourceId: query.datasourceId
      - text: Check for custom connector jobs waiting on {datasourceId}.
        slots:
          datasourceId: query.datasourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/jobs/{jobId}/catalog-data'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit metadata for cataloging
      effect: write
      questions:
      - Can a custom connector send table and column metadata to be cataloged?
      - Where does a scan job submit its metadata?
      instructions:
      - text: Submit catalog metadata for scan job {jobId}.
        slots:
          jobId: path.jobId
      - text: Send metadata list {metadataRequestList} to be cataloged for job {jobId}.
        slots:
          metadataRequestList: requestBody.metadataRequestList
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/jobs/{jobId}/classify-data'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit content for classification
      effect: write
      questions:
      - Can a custom connector send sample content to be classified for personal data?
      - Is structured and unstructured content both supported for classification?
      instructions:
      - text: Submit content {content} for classification on job {jobId} from data source {datasourceId}.
        slots:
          content: requestBody.content
          jobId: path.jobId
          datasourceId: requestBody.datasourceId
      - text: 'Classify content for scan job {jobId} (body job {bodyJobId}), source {datasourceId}: {content}.'
        slots:
          jobId: path.jobId
          bodyJobId: requestBody.jobId
          datasourceId: requestBody.datasourceId
          content: requestBody.content
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/jobs/{jobId}/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a scan job's status
      effect: write
      questions:
      - Can my connector report that a scan job finished or failed?
      - Is there a place to include an error message on a failed scan job?
      instructions:
      - text: Set scan job {jobId} status to {status}.
        slots:
          jobId: path.jobId
          status: requestBody.status
      - text: Mark job {jobId} as {status} with error {errorMessage}.
        slots:
          jobId: path.jobId
          status: requestBody.status
          errorMessage: requestBody.errorMessage
      method: generated
      generated: '2026-09-26'