API Evangelist conversational phrasing for Tech Risk & Compliance - IT Risk Management Control…

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Tech Risk & Compliance - IT Risk Management Control…
  version: 1.0.0
extends: openapi/onetrust-control-implementations-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['/api/controls/v1/control-implementation-attributes/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search control implementation attributes
      effect: read
      questions:
      - Which attributes and options can a control implementation have?
      - Can I full-text search control implementation attributes?
      instructions:
      - text: Search control implementation attributes for {fullText}.
        slots:
          fullText: requestBody.fullText
      - text: Find control implementation attributes matching filters {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/controls/v1/control-implementations/pages'].post
  update:
    x-apievangelist-phrasing:
      intent: List control implementations
      effect: read
      questions:
      - What control implementations exist across all my frameworks?
      - Can I skip the total record count to speed up listing control implementations?
      instructions:
      - text: List all control implementations.
      - text: List control implementations matching {fullText}, page {page}.
        slots:
          fullText: requestBody.fullText
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/controls/v1/control-implementations/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a control implementation
      effect: read
      questions:
      - What framework and category does a specific control implementation belong to?
      - Can I see all attributes of one control implementation?
      instructions:
      - text: Get control implementation {guid}.
        slots:
          guid: path.guid
      - text: Show attributes and framework of control implementation {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/controls/v1/control-implementations/{guid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a control implementation
      effect: write
      questions:
      - Can I set a control implementation's status and effectiveness?
      - Is it possible to change owners and deadline on a control implementation?
      instructions:
      - text: Set control implementation {guid} to status {status}.
        slots:
          guid: path.guid
          status: requestBody.status
      - text: 'Update control implementation {guid}: status {status}, effectiveness {effectiveness}, deadline {deadline}.'
        slots:
          guid: path.guid
          status: requestBody.status
          effectiveness: requestBody.effectiveness
          deadline: requestBody.deadline
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/controls/v1/control-implementations/{guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a control implementation from an entity
      effect: destructive
      questions:
      - Can I remove a control implementation from a vendor or asset?
      - Which entity ID is needed to delete a control implementation?
      instructions:
      - text: Delete control implementation {guid} from entity {entityId}.
        slots:
          guid: path.guid
          entityId: query.entityId
      - text: Remove control {guid} from entity {entityId}.
        slots:
          guid: path.guid
          entityId: query.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/controls/v1/control-implementations/{guid}/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach files to a control implementation
      effect: write
      questions:
      - Can I attach evidence files to a control implementation?
      - Do files need to be uploaded before attaching them to a control?
      instructions:
      - text: Attach files {controlAttachmentRequests} to control implementation {guid}.
        slots:
          controlAttachmentRequests: requestBody.controlAttachmentRequests
          guid: path.guid
      - text: Add the uploaded documents {controlAttachmentRequests} to control {guid}.
        slots:
          controlAttachmentRequests: requestBody.controlAttachmentRequests
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/controls/v1/entities/{entityId}/control-implementations/pages'].post
  update:
    x-apievangelist-phrasing:
      intent: List control implementations for an entity
      effect: read
      questions:
      - Which controls are implemented on a particular vendor, asset or risk?
      - Can I filter the controls attached to one processing activity?
      instructions:
      - text: List control implementations for entity {entityId}.
        slots:
          entityId: path.entityId
      - text: Show controls on entity {entityId} matching {fullText}.
        slots:
          entityId: path.entityId
          fullText: requestBody.fullText
      method: generated
      generated: '2026-09-26'