API Evangelist conversational phrasing for Thehiveryiq Com Aegis API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Thehiveryiq Com Aegis API
  version: 1.0.0
extends: openapi/thehiveryiq-com-aegis-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['/v1/aegis/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check Aegis compliance service health
      effect: read
      questions:
      - Is the Aegis compliance scanner up?
      - Can I confirm Aegis is healthy before running a control audit?
      instructions:
      - text: Check Aegis health.
      - text: Ping the Aegis service status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/aegis/control/audit'].post
  update:
    x-apievangelist-phrasing:
      intent: Audit a single compliance control
      effect: read
      questions:
      - How do I audit one control such as SOC 2 CC6.1 or ISO A.8.24?
      - Can I re-check a single control without running a full compliance scan?
      instructions:
      - text: Audit control {control_id}.
        slots:
          control_id: requestBody.control_id
      - text: Run an audit on compliance control {control_id} now.
        slots:
          control_id: requestBody.control_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/aegis/scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a full compliance scan
      effect: write
      questions:
      - How do I scan every compliance control at once?
      - Can I trigger a full Aegis scan to refresh all control results?
      instructions:
      - text: Run a full Aegis compliance scan.
      - text: Scan all controls now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/aegis/score'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the overall compliance score
      effect: read
      questions:
      - What is our current overall compliance score?
      - How compliant are we across all controls right now?
      instructions:
      - text: Show the Aegis compliance score.
      - text: Get our overall compliance score.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/aegis/control/{control_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a compliance control's status
      effect: read
      questions:
      - What is the last recorded result for a given control?
      - Where can I read the details of one compliance control by id?
      instructions:
      - text: Get control {control_id}.
        slots:
          control_id: path.control_id
      - text: Show the current status of control {control_id}.
        slots:
          control_id: path.control_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/aegis/matrix'].get
  update:
    x-apievangelist-phrasing:
      intent: View the compliance control matrix
      effect: read
      questions:
      - Which controls map to which frameworks in the compliance matrix?
      - Can I see the whole control matrix in one view?
      instructions:
      - text: Show the Aegis control matrix.
      - text: Get the compliance matrix across frameworks.
      method: generated
      generated: '2026-09-26'