OneTrust · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/api/custom-entity/v1/projects'].post
$.paths['/api/custom-entity/v1/projects/basic-details/search'].post
$.paths['/api/custom-entity/v1/projects/search'].post
$.paths['/api/custom-entity/v1/projects/{entityId}'].get
$.paths['/api/custom-entity/v1/projects/{entityId}'].put
$.paths['/api/custom-entity/v1/projects/{entityId}'].delete

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 Project Management API
  version: 1.0.0
extends: openapi/onetrust-project-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: 6
- target: $.paths['/api/custom-entity/v1/projects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Project object record
      effect: write
      questions:
      - How do I register a new AI or data project in Object Manager?
      - Can I set a project owner and deadline when creating a Project?
      instructions:
      - text: Create a Project named {name}.
        slots:
          name: requestBody.name
      - text: Create Project {name} owned by {projectOwner} with deadline {deadline}.
        slots:
          name: requestBody.name
          projectOwner: requestBody.projectOwner
          deadline: requestBody.deadline
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-entity/v1/projects/basic-details/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search Projects for basic details only
      effect: read
      questions:
      - Can I get a lightweight list of Projects with just their basic details?
      - How do I search Projects within one organization for summary info?
      instructions:
      - text: Find basic details of Projects matching {criteria}.
        slots:
          criteria: requestBody.criteria
      - text: List basic Project details for organization {requestedOrganizationId}.
        slots:
          requestedOrganizationId: requestBody.requestedOrganizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-entity/v1/projects/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search Projects with full details
      effect: read
      questions:
      - How do I search Projects and get every attribute back?
      - Can I choose which Project fields come back in a full search?
      instructions:
      - text: Search Projects with full details using query {queryRequest}.
        slots:
          queryRequest: requestBody.queryRequest
      - text: Return fields {requestedFields} for all Projects matching my query.
        slots:
          requestedFields: requestBody.requestedFields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-entity/v1/projects/{entityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Project object
      effect: read
      questions:
      - What attributes are recorded on a particular Project?
      - When was a given Project created and in which module?
      instructions:
      - text: Show Project {entityId}.
        slots:
          entityId: path.entityId
      - text: Get the attributes and created date of Project {entityId}.
        slots:
          entityId: path.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-entity/v1/projects/{entityId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Partially update a Project
      effect: write
      questions:
      - How do I rename a Project or change some of its attributes?
      - Can I move a Project to a different organization?
      instructions:
      - text: Rename Project {entityId} to {name}.
        slots:
          entityId: path.entityId
          name: requestBody.name
      - text: Update attributes {attributes} on Project {entityId}.
        slots:
          attributes: requestBody.attributes
          entityId: path.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-entity/v1/projects/{entityId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Project
      effect: destructive
      questions:
      - How do I delete a Project record I no longer need?
      - Can Projects created outside Object Manager be deleted here?
      instructions:
      - text: Delete Project {entityId}.
        slots:
          entityId: path.entityId
      - text: Remove the Project record {entityId} permanently.
        slots:
          entityId: path.entityId
      method: generated
      generated: '2026-09-26'