OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform - Object Manager Object Attribute Management API

5 actions 5 updates phrasing extends openapi/onetrust-object-attribute-management-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['/v1/schema-attribute-options'].post
$.paths['/v1/schema-attributes'].post
$.paths['/v1/schema-attributes/{attributeId}/disable'].put
$.paths['/v1/schema-attributes/{attributeId}/enable'].put

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Platform - Object Manager Object Attribute Management API
  version: 1.0.0
extends: openapi/onetrust-object-attribute-management-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['/v1/schema-attribute-options'].post
  update:
    x-apievangelist-phrasing:
      intent: Add options to a picklist attribute
      effect: write
      questions:
      - How do I add new choices to a dropdown attribute on Projects or Models?
      - Can I extend an attribute's option list in Object Manager?
      instructions:
      - text: Add options to attribute {attributeId}.
        slots:
          attributeId: query.attributeId
      - text: Extend the picklist of attribute {attributeId} with new values.
        slots:
          attributeId: query.attributeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/schema-attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new attribute to an object schema
      effect: write
      questions:
      - How do I add a custom field to the Project, Model or Dataset schema?
      - Can I make a new schema attribute required?
      instructions:
      - text: Add attribute {name} (field {fieldName}, type {responseType}) to schema {schemaName}.
        slots:
          name: requestBody.name
          fieldName: requestBody.fieldName
          responseType: requestBody.responseType
          schemaName: query.schemaName
      - text: Create a required {responseType} attribute {name} as field {fieldName} on {schemaName}, required {required}.
        slots:
          responseType: requestBody.responseType
          name: requestBody.name
          fieldName: requestBody.fieldName
          schemaName: query.schemaName
          required: requestBody.required
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/schema-attributes/{attributeId}/disable'].put
  update:
    x-apievangelist-phrasing:
      intent: Disable a schema attribute
      effect: write
      questions:
      - How do I hide an attribute from an object schema without deleting it?
      - Can I turn off an attribute on the Dataset schema?
      instructions:
      - text: Disable attribute {attributeId} on schema {schemaId}.
        slots:
          attributeId: path.attributeId
          schemaId: query.schemaId
      - text: Turn off attribute {attributeId}.
        slots:
          attributeId: path.attributeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/schema-attributes/{attributeId}/enable'].put
  update:
    x-apievangelist-phrasing:
      intent: Re-enable a schema attribute
      effect: write
      questions:
      - How do I bring back an attribute I previously disabled?
      - Can a disabled schema attribute be switched back on?
      instructions:
      - text: Enable attribute {attributeId} on schema {schemaId}.
        slots:
          attributeId: path.attributeId
          schemaId: query.schemaId
      - text: Switch attribute {attributeId} back on.
        slots:
          attributeId: path.attributeId
      method: generated
      generated: '2026-09-26'