OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tech Risk & Compliance - Enterprise Policy Management…

6 actions 6 updates phrasing extends openapi/onetrust-documents-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['/v1/{complianceType}/create'].post

$.paths['/v1/{complianceType}/list'].get

$.paths['/v1/{complianceType}/{id}/details'].get

$.paths['/v1/{complianceType}/{id}/published-version'].get

$.paths['/v1/{complianceType}/{policyId}/versions/create'].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 Tech Risk & Compliance - Enterprise Policy Management…
  version: 1.0.0
extends: openapi/onetrust-documents-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['/v1/{complianceType}/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a policy or standard document
      effect: write
      questions:
      - How do I create a new policy, standard or procedure document?
      - Who must be set as owners and approvers on a new document?
      instructions:
      - text: Create a {complianceType} named {name} in org {orgGroup} with owners {owners}, approvers {approvers} and language {defaultLanguageCode}.
        slots:
          complianceType: path.complianceType
          name: requestBody.name
          orgGroup: requestBody.orgGroup
          owners: requestBody.owners
          approvers: requestBody.approvers
          defaultLanguageCode: requestBody.defaultLanguageCode
      - text: Draft {complianceType} {name} effective {effectiveDate} for org {orgGroup}, owners {owners}, approvers {approvers}, language {defaultLanguageCode}.
        slots:
          complianceType: path.complianceType
          name: requestBody.name
          effectiveDate: requestBody.effectiveDate
          orgGroup: requestBody.orgGroup
          owners: requestBody.owners
          approvers: requestBody.approvers
          defaultLanguageCode: requestBody.defaultLanguageCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/{complianceType}/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List policy documents by type
      effect: read
      questions:
      - Which policies or procedures do we currently have?
      - Can I list only standards, not policies?
      instructions:
      - text: List all documents of type {complianceType}.
        slots:
          complianceType: path.complianceType
      - text: Show page {page} of {complianceType} documents.
        slots:
          page: query.page
          complianceType: path.complianceType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/{complianceType}/{id}/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a policy document
      effect: read
      questions:
      - What are the details of a specific policy or procedure?
      - Can I read one privacy notice document's details?
      instructions:
      - text: Get {complianceType} document {id}.
        slots:
          complianceType: path.complianceType
          id: path.id
      - text: Show details of {complianceType} {id}.
        slots:
          complianceType: path.complianceType
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/{complianceType}/{id}/published-version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document's published version as of a date
      effect: read
      questions:
      - Which version of a policy was in effect on a given date?
      - Can I retrieve the last published version of a procedure before some date?
      instructions:
      - text: Get the published version of {complianceType} {id} as of {date}.
        slots:
          complianceType: path.complianceType
          id: path.id
          date: query.date
      - text: Show which version of {complianceType} {id} was live on {date}.
        slots:
          complianceType: path.complianceType
          id: path.id
          date: query.date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/{complianceType}/{policyId}/versions/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new document version
      effect: write
      questions:
      - How do I start a new version of an existing policy?
      - Can I version a standard or procedure document?
      instructions:
      - text: Create a new version of {complianceType} {policyId}.
        slots:
          complianceType: path.complianceType
          policyId: path.policyId
      - text: Start the next revision of {complianceType} document {policyId}.
        slots:
          complianceType: path.complianceType
          policyId: path.policyId
      method: generated
      generated: '2026-09-26'