Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SafeBase API documentation Questionnaires API

3 actions 3 updates phrasing extends openapi/drata-questionnaires-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['/questionnaires/'].post

$.paths['/questionnaires/{id}/'].get

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 SafeBase API documentation Questionnaires API
  version: 1.0.0
extends: openapi/drata-questionnaires-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['/questionnaires/'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a security questionnaire
      effect: write
      questions:
      - How do I submit a customer's security questionnaire to SafeBase?
      - Can I set a due date when uploading a questionnaire?
      instructions:
      - text: Upload questionnaire file {qnr} for account {account}.
        slots:
          qnr: requestBody.qnr
          account: requestBody.accountId
      - text: Submit questionnaire {qnr} for account {account} on product {product}, due {due_date}.
        slots:
          qnr: requestBody.qnr
          account: requestBody.accountId
          product: requestBody.productId
          due_date: requestBody.dueDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/questionnaires/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a download link for a completed questionnaire
      effect: read
      questions:
      - Where can I download a questionnaire once it's completed?
      - How long does a completed questionnaire download link stay valid?
      instructions:
      - text: Get the download link for completed questionnaire {questionnaire}.
        slots:
          questionnaire: path.id
      - text: Fetch the finished file for questionnaire {questionnaire}.
        slots:
          questionnaire: path.id
      method: generated
      generated: '2026-09-26'