OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Use Governance - Data Discovery Data Sources API

5 actions 5 updates phrasing extends openapi/onetrust-data-sources-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for OneTrust's API. It is a proposal applied on top of the contract, not a document OneTrust publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/api/discovery-scan-config/v3/system'].get

$.paths['/api/discovery-scan-config/v3/system'].put

$.paths['/api/discovery-scan-config/v3/system/{id}'].get

$.paths['/api/discovery-scan-config/v3/system/{id}'].delete

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 Use Governance - Data Discovery Data Sources API
  version: 1.0.0
extends: openapi/onetrust-data-sources-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['/api/discovery-scan-config/v3/system'].get
  update:
    x-apievangelist-phrasing:
      intent: List data discovery data sources
      effect: read
      questions:
      - Which data sources are connected for data discovery scanning?
      - Can I filter data sources by system type or status?
      - What data sources were created in a given date range?
      instructions:
      - text: List all data sources.
      - text: List {systemType} data sources with status {status}.
        slots:
          systemType: query.systemType
          status: query.status
      - text: Find the data source named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/discovery-scan-config/v3/system'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a data source
      effect: write
      questions:
      - How do I register a new database or system for data discovery?
      - Can I update an existing data source's settings with the same call?
      instructions:
      - text: Create a {systemType} data source named {dataSourceName}.
        slots:
          systemType: requestBody.systemType
          dataSourceName: requestBody.dataSourceName
      - text: Update data source {id} with settings {dataSourceSettings}.
        slots:
          id: requestBody.id
          dataSourceSettings: requestBody.dataSourceSettings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/discovery-scan-config/v3/system/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data source
      effect: read
      questions:
      - What settings does a particular data source have?
      - How do I look up one data source by its ID?
      instructions:
      - text: Show data source {id}.
        slots:
          id: path.id
      - text: Get the configuration of data source {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/discovery-scan-config/v3/system/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data source
      effect: destructive
      questions:
      - How do I remove a data source and its scan results?
      - Does deleting a data source also delete its scan results?
      instructions:
      - text: Delete data source {id}.
        slots:
          id: path.id
      - text: Remove data source {id} along with its scan results.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'