OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Use Governance - Data Discovery Scan Profiles API

6 actions 6 updates phrasing extends openapi/onetrust-scan-profiles-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 6

$.info

$.paths['/api/discovery-scan-config/v2/scan-profiles'].get

$.paths['/api/discovery-scan-config/v2/scan-profiles'].put

$.paths['/api/discovery-scan-config/v2/scan-profiles'].post

$.paths['/api/discovery-scan-config/v2/scan-profiles/{scanProfileId}'].get

$.paths['/api/discovery-scan-config/v2/scan-profiles/{scanProfileId}'].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 Scan Profiles API
  version: 1.0.0
extends: openapi/onetrust-scan-profiles-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['/api/discovery-scan-config/v2/scan-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List data discovery scan profiles
      effect: read
      questions:
      - What scan profiles are configured for data discovery?
      - Can I filter scan profiles by system name, scan type or creation date?
      instructions:
      - text: List scan profiles for system {systemName}.
        slots:
          systemName: query.systemName
      - text: Show {scanType} scan profiles created between {createdFrom} and {createdTo}.
        slots:
          scanType: query.scanType
          createdFrom: query.createdFrom
          createdTo: query.createdTo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/discovery-scan-config/v2/scan-profiles'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a scan profile
      effect: write
      questions:
      - How do I change the paths or settings of an existing scan profile?
      - Can I rename a scan profile?
      instructions:
      - text: 'Update scan profile {id}: name {name}, scan type {scanType}, system {systemName} ({systemType}), context {scanProfileContext}.'
        slots:
          id: requestBody.id
          name: requestBody.name
          scanType: requestBody.scanType
          systemName: requestBody.systemName
          systemType: requestBody.systemType
          scanProfileContext: requestBody.scanProfileContext
      - text: Change the display name of scan profile {id} to {displayName}.
        slots:
          id: requestBody.id
          displayName: requestBody.displayName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/discovery-scan-config/v2/scan-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scan profile
      effect: write
      questions:
      - How do I define what a data discovery scan should look at on a system?
      - What do I need to set up a new scan profile?
      instructions:
      - text: Create scan profile {name} of type {scanType} for {systemType} system {systemName} with context {scanProfileContext}.
        slots:
          name: requestBody.name
          scanType: requestBody.scanType
          systemType: requestBody.systemType
          systemName: requestBody.systemName
          scanProfileContext: requestBody.scanProfileContext
      - text: Set up a new {scanType} scan profile {name} on {systemName} ({systemType}) using {scanProfileContext}.
        slots:
          scanType: requestBody.scanType
          name: requestBody.name
          systemName: requestBody.systemName
          systemType: requestBody.systemType
          scanProfileContext: requestBody.scanProfileContext
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/discovery-scan-config/v2/scan-profiles/{scanProfileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one scan profile
      effect: read
      questions:
      - Which paths and system does a particular scan profile cover?
      - What scan type is a given scan profile set to?
      instructions:
      - text: Show scan profile {scanProfileId}.
        slots:
          scanProfileId: path.scanProfileId
      - text: Get the system and paths configured on scan profile {scanProfileId}.
        slots:
          scanProfileId: path.scanProfileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/discovery-scan-config/v2/scan-profiles/{scanProfileId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scan profile
      effect: destructive
      questions:
      - How do I remove a scan profile that is no longer needed?
      - Can I delete a data discovery scan profile by ID?
      instructions:
      - text: Delete scan profile {scanProfileId}.
        slots:
          scanProfileId: path.scanProfileId
      - text: Remove the scan profile {scanProfileId} permanently.
        slots:
          scanProfileId: path.scanProfileId
      method: generated
      generated: '2026-09-26'