Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drata User Documents API

5 actions 5 updates phrasing extends openapi/drata-user-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['/users/{userId}/documents'].get

$.paths['/users/{userId}/documents'].post

$.paths['/users/{userId}/documents/{documentId}'].get

$.paths['/users/{userId}/documents/{documentId}'].delete

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 User Documents API
  version: 1.0.0
extends: openapi/drata-user-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['/users/{userId}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's documents
      effect: read
      questions:
      - What documents has an employee uploaded, like training certificates?
      - Can I filter a user's documents by type?
      instructions:
      - text: List documents for user {user}.
        slots:
          user: path.userId
      - text: Show documents of type {type} for user {user}.
        slots:
          type: query.type
          user: path.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{userId}/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a document for a user
      effect: write
      questions:
      - How do I upload proof that an employee finished security training?
      - Can I record the completion date when I upload a user document?
      instructions:
      - text: Upload a {type} document for user {user}.
        slots:
          type: requestBody.type
          user: path.userId
      - text: Upload a {type} document for user {user} completed on {completion_date}.
        slots:
          type: requestBody.type
          user: path.userId
          completion_date: requestBody.completionDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{userId}/documents/{documentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user document
      effect: read
      questions:
      - Can I retrieve a specific document a user uploaded?
      - What are the details of one employee document?
      instructions:
      - text: Get document {document} for user {user}.
        slots:
          document: path.documentId
          user: path.userId
      - text: Show user document {document} belonging to {user}.
        slots:
          document: path.documentId
          user: path.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{userId}/documents/{documentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user document
      effect: destructive
      questions:
      - Can I remove a document uploaded for an employee?
      - Is deleting a user document permanent?
      instructions:
      - text: Delete document {document} from user {user}.
        slots:
          document: path.documentId
          user: path.userId
      - text: Remove the wrong upload {document} from {user}'s documents.
        slots:
          document: path.documentId
          user: path.userId
      method: generated
      generated: '2026-09-26'