Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drata Evidence Library API

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

$.info
$.paths['/workspaces/{workspaceId}/evidence-library'].get
$.paths['/workspaces/{workspaceId}/evidence-library'].post
$.paths['/workspaces/{workspaceId}/evidence-library/{evidenceLibraryId}'].get
$.paths['/workspaces/{workspaceId}/evidence-library/{evidenceLibraryId}'].put
$.paths['/workspaces/{workspaceId}/evidence-library/{evidenceLibraryId}'].delete
$.paths['/workspaces/{workspaceId}/evidence-library/{evidenceLibraryId}/versions/{versionId}'].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 Evidence Library API
  version: 1.0.0
extends: openapi/drata-evidence-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: 6
- target: $.paths['/workspaces/{workspaceId}/evidence-library'].get
  update:
    x-apievangelist-phrasing:
      intent: List evidence library items (legacy)
      effect: read
      questions:
      - What items are in our evidence library under the older endpoint?
      - Can I search the legacy evidence library by name or status?
      instructions:
      - text: List evidence library items in workspace {workspace} using the legacy endpoint.
        slots:
          workspace: path.workspaceId
      - text: Search the legacy evidence library in workspace {workspace} for {name}.
        slots:
          workspace: path.workspaceId
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/evidence-library'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an evidence library item (legacy)
      effect: write
      questions:
      - Can I still add a single-file evidence library item the old way?
      - Is it possible to create a legacy evidence library item from a URL or ticket link?
      instructions:
      - text: Create legacy evidence library item {name} in workspace {workspace}.
        slots:
          name: requestBody.name
          workspace: path.workspaceId
      - text: Add evidence library item {name} pointing at URL {url} via the older endpoint.
        slots:
          name: requestBody.name
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/evidence-library/{evidenceLibraryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an evidence library item (legacy)
      effect: read
      questions:
      - Can I fetch one evidence library item by its legacy ID?
      - What does an older evidence library record contain?
      instructions:
      - text: Get legacy evidence library item {item} in workspace {workspace}.
        slots:
          item: path.evidenceLibraryId
          workspace: path.workspaceId
      - text: Show evidence library record {item} from the older API.
        slots:
          item: path.evidenceLibraryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/evidence-library/{evidenceLibraryId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an evidence library item (legacy)
      effect: write
      questions:
      - Can I change the renewal date on a legacy evidence library item?
      - Is it possible to swap the file on an older evidence library record?
      instructions:
      - text: Update legacy evidence library item {item} in workspace {workspace} to renew on {renewal_date}.
        slots:
          item: path.evidenceLibraryId
          workspace: path.workspaceId
          renewal_date: requestBody.renewalDate
      - text: Set the ticket URL of evidence library item {item} to {ticket_url}.
        slots:
          item: path.evidenceLibraryId
          ticket_url: requestBody.ticketUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/evidence-library/{evidenceLibraryId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an evidence library item
      effect: destructive
      questions:
      - Can I remove an item from the evidence library by its library ID?
      - Is deleting an evidence library item permanent?
      instructions:
      - text: Delete evidence library item {item} from workspace {workspace}.
        slots:
          item: path.evidenceLibraryId
          workspace: path.workspaceId
      - text: Remove library record {item} from the evidence library.
        slots:
          item: path.evidenceLibraryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/evidence-library/{evidenceLibraryId}/versions/{versionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a version of an evidence library item
      effect: read
      questions:
      - Can I see an earlier version of an evidence library item?
      - What did a specific version of a library record contain?
      instructions:
      - text: Get version {version} of evidence library item {item} in workspace {workspace}.
        slots:
          version: path.versionId
          item: path.evidenceLibraryId
          workspace: path.workspaceId
      - text: Show version {version} details for library item {item}.
        slots:
          version: path.versionId
          item: path.evidenceLibraryId
      method: generated
      generated: '2026-09-26'