Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drata Risk Library API

4 actions 4 updates phrasing extends openapi/drata-risk-library-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['/risk-registers/{riskRegisterId}/risk-library'].get

$.paths['/risk-registers/{riskRegisterId}/risk-library/{riskLibraryId}'].get

$.paths['/risk-library/action-copy'].post

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 Risk Library API
  version: 1.0.0
extends: openapi/drata-risk-library-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['/risk-registers/{riskRegisterId}/risk-library'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse the risk library
      effect: read
      questions:
      - Which prebuilt risks are in the risk library?
      - Can I search the library for risks by title or description?
      instructions:
      - text: List library risks for register {riskRegisterId}.
        slots:
          riskRegisterId: path.riskRegisterId
      - text: Search the risk library for register {riskRegisterId} with title containing {title}.
        slots:
          riskRegisterId: path.riskRegisterId
          title: query.title
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risk-registers/{riskRegisterId}/risk-library/{riskLibraryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a risk library item
      effect: read
      questions:
      - What are the details of one risk template in the library?
      - Can I look up a library risk by its ID?
      instructions:
      - text: Get library risk {riskLibraryId} for register {riskRegisterId}.
        slots:
          riskRegisterId: path.riskRegisterId
          riskLibraryId: path.riskLibraryId
      - text: Show risk library item {riskLibraryId} (register {riskRegisterId}) with {expand} expanded.
        slots:
          riskRegisterId: path.riskRegisterId
          riskLibraryId: path.riskLibraryId
          expand: query.expand[]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risk-library/action-copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy library risks into a register
      effect: write
      questions:
      - How do I copy risks from the library into my risk register?
      - Can I copy whole risk groups from the library at once?
      instructions:
      - text: Copy library risks {riskIds} and groups {riskGroups} into register {registerId} using {bulkActionType}.
        slots:
          riskIds: requestBody.riskIds
          riskGroups: requestBody.riskGroups
          registerId: requestBody.registerId
          bulkActionType: requestBody.bulkActionType
      - text: Add library risk groups {riskGroups} and risks {riskIds} to register {registerId} with action {bulkActionType}.
        slots:
          riskIds: requestBody.riskIds
          riskGroups: requestBody.riskGroups
          registerId: requestBody.registerId
          bulkActionType: requestBody.bulkActionType
      method: generated
      generated: '2026-09-26'