# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Drata Monitoring Tests API
  version: 1.0.0
extends: openapi/drata-monitoring-tests-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}/monitoring-tests'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitoring tests
      effect: read
      questions:
      - Which monitoring tests are currently failing in my workspace?
      - Can I list only my custom tests versus the built-in ones?
      instructions:
      - text: List monitoring tests in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: List tests in workspace {workspaceId} with result status {checkResultStatus}.
        slots:
          workspaceId: path.workspaceId
          checkResultStatus: query.checkResultStatus
      - text: Show tests from source {testSource} in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
          testSource: query.testSource
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/monitoring-tests/{testId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a monitoring test
      effect: read
      questions:
      - How do I look up a single monitoring test by its test ID?
      - What's the current state of one specific monitoring test?
      instructions:
      - text: Get monitoring test {testId} in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
          testId: path.testId
      - text: Show test {testId} from workspace {workspaceId} with {expand} expanded.
        slots:
          workspaceId: path.workspaceId
          testId: path.testId
          expand: query.expand[]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/monitoring-tests/{testId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename, describe or disable a monitoring test
      effect: write
      questions:
      - Can I turn off a monitoring test we don't need?
      - Is it possible to rename a test or change its description?
      instructions:
      - text: Rename monitoring test {testId} in workspace {workspaceId} to {name}.
        slots:
          workspaceId: path.workspaceId
          testId: path.testId
          name: requestBody.name
      - text: Set enabled to {enabled} for test {testId} in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
          testId: path.testId
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/monitoring-tests/{testId}/exclusions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a monitoring test's exclusions
      effect: read
      questions:
      - Which resources are excluded from a monitoring test?
      - Can I check whether one resource has an exclusion on a test?
      instructions:
      - text: List exclusions for test {testId} in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
          testId: path.testId
      - text: Check whether resource {targetId} is excluded from test {testId} in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
          testId: path.testId
          targetId: query.targetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/monitoring-tests/{testId}/failures'].get
  update:
    x-apievangelist-phrasing:
      intent: List a monitoring test's failures
      effect: read
      questions:
      - Which resources are failing a particular monitoring test?
      - Can the failure list also include failures that were excluded?
      instructions:
      - text: List failures for test {testId} in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
          testId: path.testId
      - text: 'List failing resources for test {testId} in workspace {workspaceId}, including exclusions: {includeExclusions}.'
        slots:
          workspaceId: path.workspaceId
          testId: path.testId
          includeExclusions: query.includeExclusions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/monitoring-tests/{testId}/passes'].get
  update:
    x-apievangelist-phrasing:
      intent: List resources passing a monitoring test
      effect: read
      questions:
      - Which resources currently pass a given monitoring test?
      - Why would the passing-resources list for a test come back empty?
      instructions:
      - text: List passing resources for test {testId} in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
          testId: path.testId
      - text: Show what passes test {testId} in workspace {workspaceId}, with tags expanded via {expand}.
        slots:
          workspaceId: path.workspaceId
          testId: path.testId
          expand: query.expand[]
      method: generated
      generated: '2026-09-26'