# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Drata Custom Data Records API
  version: 1.0.0
extends: openapi/drata-custom-data-records-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: 7
- target: $.paths['/custom-connections/{connectionId}/resources/{resourceId}/records'].get
  update:
    x-apievangelist-phrasing:
      intent: List records for a custom connection resource
      effect: read
      questions:
      - What data records have we pushed to a custom connection?
      - Can I list only the records uploaded in one session?
      instructions:
      - text: List records for resource {resource} on custom connection {connection}.
        slots:
          connection: path.connectionId
          resource: path.resourceId
      - text: Show records from session {session} for resource {resource} on connection {connection}.
        slots:
          connection: path.connectionId
          resource: path.resourceId
          session: query.sessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-connections/{connectionId}/resources/{resourceId}/records'].post
  update:
    x-apievangelist-phrasing:
      intent: Upsert custom data records
      effect: write
      questions:
      - How do I push my own data into a custom connection?
      - Does sending a record create it or update the existing one?
      instructions:
      - text: Upsert records {data} into resource {resource} of custom connection {connection}.
        slots:
          connection: path.connectionId
          resource: path.resourceId
          data: requestBody.data
      - text: Send these records {data} to connection {connection}, resource {resource}.
        slots:
          connection: path.connectionId
          resource: path.resourceId
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-connections/{connectionId}/resources/{resourceId}/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List upload sessions for a resource
      effect: read
      questions:
      - Which batch upload sessions exist for a custom resource?
      - Can I filter custom data sessions by status?
      instructions:
      - text: List upload sessions for resource {resource} on connection {connection}.
        slots:
          connection: path.connectionId
          resource: path.resourceId
      - text: Show sessions with status {status} for resource {resource} on connection {connection}.
        slots:
          connection: path.connectionId
          resource: path.resourceId
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-connections/{connectionId}/resources/{resourceId}/sessions/{sessionId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a batch of records in a session
      effect: write
      questions:
      - Can I upload custom data in batches inside a session?
      - How do I add more records to an open upload session?
      instructions:
      - text: Upload batch {data} to session {session} for resource {resource} on connection {connection}.
        slots:
          connection: path.connectionId
          resource: path.resourceId
          data: requestBody.data
          session: path.sessionId
      - text: Add records {data} to open session {session}.
        slots:
          data: requestBody.data
          session: path.sessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-connections/{connectionId}/resources/{resourceId}/sessions/{sessionId}/actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Act on a custom data upload session
      effect: write
      questions:
      - How do I finish or close a custom data upload session?
      - What actions can I take on an upload session?
      instructions:
      - text: Perform action {action} on session {session} for resource {resource} on connection {connection}.
        slots:
          connection: path.connectionId
          resource: path.resourceId
          action: requestBody.action
          session: path.sessionId
      - text: Apply {action} to upload session {session}.
        slots:
          action: requestBody.action
          session: path.sessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-connections/{connectionId}/resources/{resourceId}/records/{recordId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one custom data record
      effect: write
      questions:
      - Can I update a single custom data record by its ID?
      - Is it possible to correct one record without re-uploading everything?
      instructions:
      - text: Update record {record} in resource {resource} on connection {connection} with {data}.
        slots:
          connection: path.connectionId
          resource: path.resourceId
          record: path.recordId
          data: requestBody.data
      - text: Replace the data of record {record} with {data}.
        slots:
          record: path.recordId
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-connections/{connectionId}/resources/{resourceId}/records/{recordId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one custom data record
      effect: destructive
      questions:
      - Can I delete a single record from a custom connection?
      - Is removing a custom data record permanent?
      instructions:
      - text: Delete record {record} from resource {resource} on connection {connection}.
        slots:
          connection: path.connectionId
          resource: path.resourceId
          record: path.recordId
      - text: Remove custom data record {record}.
        slots:
          record: path.recordId
      method: generated
      generated: '2026-09-26'