Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drata Events API

5 actions 5 updates phrasing extends openapi/drata-events-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 5

$.info

$.paths['/events'].get

$.paths['/events/{eventId}'].get

$.paths['/events/{eventId}/download-jobs'].post

$.paths['/events/{eventId}/download-jobs/{jobId}'].get

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 Drata Events API
  version: 1.0.0
extends: openapi/drata-events-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['/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List activity events
      effect: read
      questions:
      - What happened in our Drata account last week?
      - Can I filter events by user, connection or category?
      - Which events were created within a date range?
      instructions:
      - text: List events created between {start} and {end}.
        slots:
          start: query.createdAtStartDate
          end: query.createdAtEndDate
      - text: Show events triggered by user {user}.
        slots:
          user: query.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{eventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one event
      effect: read
      questions:
      - What are the details of a specific event?
      - Can I look up an event by ID?
      instructions:
      - text: Get event {event}.
        slots:
          event: path.eventId
      - text: Show me what event {event} recorded.
        slots:
          event: path.eventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{eventId}/download-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a PDF export of an event
      effect: write
      questions:
      - Can I export an event as a PDF?
      - How do I generate a downloadable PDF for an event?
      instructions:
      - text: Start a PDF download job for event {event}.
        slots:
          event: path.eventId
      - text: Generate a PDF of event {event}.
        slots:
          event: path.eventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{eventId}/download-jobs/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an event PDF export job
      effect: read
      questions:
      - Is my event PDF ready to download yet?
      - What is the status of an event PDF export job?
      instructions:
      - text: Check PDF job {job} for event {event}.
        slots:
          job: path.jobId
          event: path.eventId
      - text: Get the PDF export {job} for event {event}.
        slots:
          job: path.jobId
          event: path.eventId
      method: generated
      generated: '2026-09-26'