Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drata Background Checks API

2 actions 2 updates phrasing extends openapi/drata-background-checks-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 2

$.info
$.paths['/background-checks'].post

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 Background Checks API
  version: 1.0.0
extends: openapi/drata-background-checks-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: 1
- target: $.paths['/background-checks'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a manual background check
      effect: write
      questions:
      - How do I record a background check done outside Drata?
      - Can I mark an employee compliant for background checks with a link to the report?
      instructions:
      - text: Record a background check for user {user} filed on {filed_at}.
        slots:
          user: requestBody.userId
          filed_at: requestBody.filedAt
      - text: Add a manual background check for {user} filed {filed_at} with report link {url}.
        slots:
          user: requestBody.userId
          filed_at: requestBody.filedAt
          url: requestBody.url
      method: generated
      generated: '2026-09-26'