Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SafeBase API documentation Trust Center Updates API

10 actions 10 updates phrasing extends openapi/drata-trust-center-updates-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Drata's API. It is a proposal applied on top of the contract, not a document Drata publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/tcu/topics/'].get
$.paths['/tcu/topics/'].post
$.paths['/tcu/topics/{topicId}'].get
$.paths['/tcu/topics/{topicId}'].delete
$.paths['/tcu/topics/{topicId}'].patch
$.paths['/tcu/topics/{topicId}/updates'].post
$.paths['/tcu/topics/{topicId}/updates/{updateId}'].get
$.paths['/tcu/topics/{topicId}/updates/{updateId}'].delete
$.paths['/tcu/topics/{topicId}/updates/{updateId}'].patch

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 SafeBase API documentation Trust Center Updates API
  version: 1.0.0
extends: openapi/drata-trust-center-updates-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: 9
- target: $.paths['/tcu/topics/'].get
  update:
    x-apievangelist-phrasing:
      intent: List Trust Center update topics
      effect: read
      questions:
      - What topics are set up for Trust Center updates?
      - Which subjects do we post Trust Center announcements under?
      instructions:
      - text: List all Trust Center update topics.
      - text: Show me our top-level Trust Center topics.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tcu/topics/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Trust Center update topic
      effect: write
      questions:
      - How do I start a new topic for Trust Center announcements?
      - Can I create a Trust Center topic that stays hidden?
      instructions:
      - text: Create a Trust Center topic {subject} in category {category}.
        slots:
          subject: requestBody.subject
          category: requestBody.category
      - text: Add a Trust Center topic {subject} under {category} with hidden set to {hidden}.
        slots:
          subject: requestBody.subject
          category: requestBody.category
          hidden: requestBody.hidden
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tcu/topics/{topicId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Trust Center topic
      effect: read
      questions:
      - What are the details of one Trust Center topic?
      - Can I look up a Trust Center topic by ID?
      instructions:
      - text: Get Trust Center topic {topic}.
        slots:
          topic: path.topicId
      - text: Show me topic {topic} from our Trust Center.
        slots:
          topic: path.topicId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tcu/topics/{topicId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Trust Center topic
      effect: destructive
      questions:
      - Can I remove a Trust Center topic we no longer use?
      - What happens when I delete a Trust Center topic?
      instructions:
      - text: Delete Trust Center topic {topic}.
        slots:
          topic: path.topicId
      - text: Remove topic {topic} from the Trust Center.
        slots:
          topic: path.topicId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tcu/topics/{topicId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Trust Center topic
      effect: write
      questions:
      - Can I change the subject or visibility of a Trust Center topic?
      - Is it possible to edit an existing Trust Center topic?
      instructions:
      - text: Update Trust Center topic {topic}.
        slots:
          topic: path.topicId
      - text: Edit the settings of Trust Center topic {topic}.
        slots:
          topic: path.topicId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tcu/topics/{topicId}/updates'].post
  update:
    x-apievangelist-phrasing:
      intent: Post an update to a Trust Center topic
      effect: write
      questions:
      - How do I post a new security update to our Trust Center?
      - Which channels can a Trust Center update be sent through?
      instructions:
      - text: Post update {message} to Trust Center topic {topic} via {channels}.
        slots:
          message: requestBody.message
          topic: path.topicId
          channels: requestBody.channels
      - text: Publish a Trust Center update under topic {topic} saying {message} on channels {channels}.
        slots:
          topic: path.topicId
          message: requestBody.message
          channels: requestBody.channels
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tcu/topics/{topicId}/updates/{updateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Trust Center update
      effect: read
      questions:
      - Can I retrieve a specific Trust Center update we posted?
      - What did a particular Trust Center update say?
      instructions:
      - text: Get update {update} in Trust Center topic {topic}.
        slots:
          update: path.updateId
          topic: path.topicId
      - text: Show the Trust Center update {update} posted under topic {topic}.
        slots:
          update: path.updateId
          topic: path.topicId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tcu/topics/{topicId}/updates/{updateId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Trust Center update
      effect: destructive
      questions:
      - Can I take down an update I posted to the Trust Center?
      - Is deleting a Trust Center update reversible?
      instructions:
      - text: Delete update {update} from Trust Center topic {topic}.
        slots:
          update: path.updateId
          topic: path.topicId
      - text: Remove Trust Center update {update} under topic {topic}.
        slots:
          update: path.updateId
          topic: path.topicId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tcu/topics/{topicId}/updates/{updateId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit the message of a Trust Center update
      effect: write
      questions:
      - Can I fix a typo in a Trust Center update after posting it?
      - Is it possible to change the text of an existing Trust Center update?
      instructions:
      - text: Change the message of update {update} in topic {topic} to {message}.
        slots:
          update: path.updateId
          topic: path.topicId
          message: requestBody.message
      - text: Edit Trust Center update {update} under topic {topic}.
        slots:
          update: path.updateId
          topic: path.topicId
      method: generated
      generated: '2026-09-26'