OneTrust · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/onetrust-credentials-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/credentials'].get

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

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

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

$.paths['/api/discovery-scan-config/v2/credentials/{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 Credentials API
  version: 1.0.0
extends: openapi/onetrust-credentials-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/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List data discovery credentials
      effect: read
      questions:
      - Which credentials are configured for data discovery scans?
      - Can I filter credentials by system name?
      instructions:
      - text: List all credentials.
      - text: Find credentials for system {systemName}.
        slots:
          systemName: query.systemName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/discovery-scan-config/v2/credentials'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a credential
      effect: write
      questions:
      - Can I change the reference key on an existing credential?
      - Is it possible to move a credential to another worker node?
      instructions:
      - text: Update credential {id} to reference key {referenceKey}.
        slots:
          id: requestBody.id
          referenceKey: requestBody.referenceKey
      - text: Change credential {id}'s worker node to {workerNodeName}.
        slots:
          id: requestBody.id
          workerNodeName: requestBody.workerNodeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/discovery-scan-config/v2/credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a credential
      effect: write
      questions:
      - How do I add a credential for a scan of a new system?
      - What does a new credential need, like a reference key and worker node?
      instructions:
      - text: Create credential {name} for system {systemName} with reference key {referenceKey}.
        slots:
          name: requestBody.name
          systemName: requestBody.systemName
          referenceKey: requestBody.referenceKey
      - text: Add a credential named {name} on worker node {workerNodeName}.
        slots:
          name: requestBody.name
          workerNodeName: requestBody.workerNodeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/discovery-scan-config/v2/credentials/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a credential
      effect: read
      questions:
      - What system and reference key does a specific credential use?
      - Can I look up one credential by its ID?
      instructions:
      - text: Get credential {id}.
        slots:
          id: path.id
      - text: Show details of credential {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/discovery-scan-config/v2/credentials/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a credential
      effect: destructive
      questions:
      - Does deleting a credential remove its reference keys too?
      - Can I delete a credential I no longer scan with?
      instructions:
      - text: Delete credential {id}.
        slots:
          id: path.id
      - text: Remove credential {id} and its reference keys.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'