Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drata Audits API

3 actions 3 updates phrasing extends openapi/drata-audits-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 3

$.info
$.paths['/workspaces/{workspaceId}/audits'].get
$.paths['/workspaces/{workspaceId}/audits/{auditId}'].get

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 Drata Audits API
  version: 1.0.0
extends: openapi/drata-audits-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: 2
- target: $.paths['/workspaces/{workspaceId}/audits'].get
  update:
    x-apievangelist-phrasing:
      intent: List audits
      effect: read
      questions:
      - Which audits are running in my workspace?
      - Can I page through all audits for a workspace?
      instructions:
      - text: List audits in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Show audits for workspace {workspaceId}, {size} per page.
        slots:
          workspaceId: path.workspaceId
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/audits/{auditId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an audit
      effect: read
      questions:
      - What are the details of one audit?
      - Can I look up a specific audit by its ID?
      instructions:
      - text: Get audit {auditId} in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
          auditId: path.auditId
      - text: Show audit {auditId} from workspace {workspaceId} with {expand} expanded.
        slots:
          workspaceId: path.workspaceId
          auditId: path.auditId
          expand: query.expand[]
      method: generated
      generated: '2026-09-26'