Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drata Vendor Documents API

4 actions 4 updates phrasing extends openapi/drata-vendor-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 4

$.info
$.paths['/vendors/{vendorId}/documents'].get
$.paths['/vendors/{vendorId}/documents'].post
$.paths['/vendors/{vendorId}/documents/{documentId}'].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 Vendor Documents API
  version: 1.0.0
extends: openapi/drata-vendor-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: 3
- target: $.paths['/vendors/{vendorId}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List a vendor's documents
      effect: read
      questions:
      - What documents do we have on file for a vendor, like a SOC 2 report?
      - Can I filter a vendor's documents by type?
      instructions:
      - text: List documents for vendor {vendor}.
        slots:
          vendor: path.vendorId
      - text: Show vendor {vendor} documents of type {type}.
        slots:
          vendor: path.vendorId
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vendors/{vendorId}/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a vendor document
      effect: write
      questions:
      - How do I upload a vendor's security report?
      - Can I attach a vendor document to a specific security review?
      instructions:
      - text: Upload this file as a document for vendor {vendor}.
        slots:
          vendor: path.vendorId
      - text: Upload a {type} document to vendor {vendor} for security review {review}.
        slots:
          type: requestBody.type
          vendor: path.vendorId
          review: requestBody.securityReviewId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vendors/{vendorId}/documents/{documentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one vendor document
      effect: read
      questions:
      - Can I retrieve a single document we stored for a vendor?
      - What are the details of one vendor document?
      instructions:
      - text: Get document {document} for vendor {vendor}.
        slots:
          document: path.documentId
          vendor: path.vendorId
      - text: Show vendor {vendor}'s document {document}.
        slots:
          vendor: path.vendorId
          document: path.documentId
      method: generated
      generated: '2026-09-26'