# 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 Registers API
  version: 1.0.0
extends: openapi/drata-risk-registers-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: 5
- target: $.paths['/risk-registers'].get
  update:
    x-apievangelist-phrasing:
      intent: List risk registers
      effect: read
      questions:
      - Which risk registers exist in our account?
      - Can I filter risk registers by owner or workspace?
      instructions:
      - text: List risk registers named like {name}.
        slots:
          name: query.name
      - text: Show risk registers owned by users {ownerIds}.
        slots:
          ownerIds: query.ownerIds[]
      - text: List risk registers for workspaces {workspaceIds}.
        slots:
          workspaceIds: query.workspaceIds[]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risk-registers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a risk register
      effect: write
      questions:
      - How do I create a new risk register?
      - Can I assign owners and workspaces when creating a register?
      instructions:
      - text: Create a risk register named {name}.
        slots:
          name: requestBody.name
      - text: Create risk register {name} owned by {ownerIds} for workspaces {workspaceIds}.
        slots:
          name: requestBody.name
          ownerIds: requestBody.ownerIds
          workspaceIds: requestBody.workspaceIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risk-registers/{riskRegisterId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a risk register
      effect: read
      questions:
      - What are the details of one risk register?
      - Who owns a particular risk register?
      instructions:
      - text: Get risk register {riskRegisterId}.
        slots:
          riskRegisterId: path.riskRegisterId
      - text: Show the owners and details of risk register {riskRegisterId}.
        slots:
          riskRegisterId: path.riskRegisterId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risk-registers/{riskRegisterId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a risk register
      effect: write
      questions:
      - How do I rename a risk register?
      - Can I change which workspaces a register is linked to?
      instructions:
      - text: Rename risk register {riskRegisterId} to {name}.
        slots:
          riskRegisterId: path.riskRegisterId
          name: requestBody.name
      - text: Set the owners of risk register {riskRegisterId} to {ownerIds}.
        slots:
          riskRegisterId: path.riskRegisterId
          ownerIds: requestBody.ownerIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/risk-registers/{riskRegisterId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a risk register
      effect: destructive
      questions:
      - Can I delete a risk register we no longer use?
      - What's needed to remove a whole risk register?
      instructions:
      - text: Delete risk register {riskRegisterId}.
        slots:
          riskRegisterId: path.riskRegisterId
      - text: Remove the entire risk register {riskRegisterId}.
        slots:
          riskRegisterId: path.riskRegisterId
      method: generated
      generated: '2026-09-26'