Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drata User's Assigned Policies API

3 actions 3 updates phrasing extends openapi/drata-user-s-assigned-policies-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['/users/{userId}/assigned-policies'].get
$.paths['/users/{userId}/assigned-policies/{policyId}/action-acknowledge'].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 User's Assigned Policies API
  version: 1.0.0
extends: openapi/drata-user-s-assigned-policies-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['/users/{userId}/assigned-policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's assigned policies
      effect: read
      questions:
      - Which policies has a given employee been assigned?
      - Can I look up someone's assigned policies by email?
      instructions:
      - text: List assigned policies for user {userId}.
        slots:
          userId: path.userId
      - text: Show the policies assigned to {userId} with {expand} expanded.
        slots:
          userId: path.userId
          expand: query.expand[]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{userId}/assigned-policies/{policyId}/action-acknowledge'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a user's policy acknowledgment
      effect: write
      questions:
      - How do I mark that an employee accepted a policy?
      - How far back can a policy acceptance date be recorded?
      instructions:
      - text: Record that user {userId} acknowledged policy {policyId} on {acceptedAt}.
        slots:
          userId: path.userId
          policyId: path.policyId
          acceptedAt: requestBody.acceptedAt
      - text: Mark policy {policyId} accepted by {userId} at {acceptedAt}, noting {details}.
        slots:
          userId: path.userId
          policyId: path.policyId
          acceptedAt: requestBody.acceptedAt
          details: requestBody.details
      method: generated
      generated: '2026-09-26'