OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform - Integrations System Credentials API

3 actions 3 updates phrasing extends openapi/onetrust-system-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 3

$.info

$.paths['/v2/credentials/{type}'].put

$.paths['/v2/credentials/{type}'].post

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 Platform - Integrations System Credentials API
  version: 1.0.0
extends: openapi/onetrust-system-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: 2
- target: $.paths['/v2/credentials/{type}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a connector system credential
      effect: write
      questions:
      - How do I rotate the secret on an existing integration credential?
      - Can I change the auth type of a system credential?
      instructions:
      - text: Update the {type} credential {name} with auth type {authType} and context {authContext} for integration {integrationName}.
        slots:
          type: path.type
          name: query.name
          authType: requestBody.authType
          authContext: requestBody.authContext
          integrationName: requestBody.integrationName
      - text: Rotate the {type} system credential {name} to new auth context {authContext}.
        slots:
          type: path.type
          name: query.name
          authContext: requestBody.authContext
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/credentials/{type}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a system credential for a connector
      effect: write
      questions:
      - How do I store credentials for a new integration connector?
      - What auth details does a new system credential need?
      instructions:
      - text: Create a {type} credential {name} using {authType} auth for integration {integrationName}.
        slots:
          type: path.type
          name: requestBody.name
          authType: requestBody.authType
          integrationName: requestBody.integrationName
      - text: Add new {type} system credential {name} ({authType}) with context {authContext} for {integrationName}.
        slots:
          type: path.type
          name: requestBody.name
          authType: requestBody.authType
          authContext: requestBody.authContext
          integrationName: requestBody.integrationName
      method: generated
      generated: '2026-09-26'