Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drata Device Documents API

5 actions 5 updates phrasing extends openapi/drata-device-documents-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['/devices/{deviceId}/documents'].get
$.paths['/devices/{deviceId}/documents'].post
$.paths['/devices/{deviceId}/documents/{documentId}'].get
$.paths['/devices/{deviceId}/documents/{documentId}'].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 Drata Device Documents API
  version: 1.0.0
extends: openapi/drata-device-documents-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['/devices/{deviceId}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List a device's compliance documents
      effect: read
      questions:
      - What compliance documents are attached to a device?
      - Can I list only one type of document for a device?
      instructions:
      - text: List documents for device {deviceId}.
        slots:
          deviceId: path.deviceId
      - text: Show only the {type} compliance files uploaded for device {deviceId}.
        slots:
          deviceId: path.deviceId
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a device compliance document
      effect: write
      questions:
      - How do I upload a compliance document for a device?
      - Can I send the device document as Base64 instead of a file?
      instructions:
      - text: Upload {file} as a {type} document for device {deviceId}.
        slots:
          deviceId: path.deviceId
          file: requestBody.file
          type: requestBody.type
      - text: Attach Base64 evidence {base64File} to device {deviceId} as type {type}.
        slots:
          deviceId: path.deviceId
          base64File: requestBody.base64File
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/documents/{documentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device document
      effect: read
      questions:
      - Can I view one specific document attached to a device?
      - What details are stored for a single device document?
      instructions:
      - text: Get document {documentId} of device {deviceId}.
        slots:
          deviceId: path.deviceId
          documentId: path.documentId
      - text: Show device {deviceId}'s document {documentId}.
        slots:
          deviceId: path.deviceId
          documentId: path.documentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/documents/{documentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a device document
      effect: destructive
      questions:
      - How do I remove a document uploaded to a device?
      - Can a wrong device compliance document be deleted?
      instructions:
      - text: Delete document {documentId} from device {deviceId}.
        slots:
          deviceId: path.deviceId
          documentId: path.documentId
      - text: Remove the compliance document {documentId} attached to device {deviceId}.
        slots:
          deviceId: path.deviceId
          documentId: path.documentId
      method: generated
      generated: '2026-09-26'