# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Agent Handler Subpackage Custom Regex Rules API
  version: 1.0.0
extends: openapi/merge-subpackage-customregexrules-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: 10
- target: $.paths['/api/v1/security/custom-regex-rules/'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization custom regex rules
      effect: read
      questions:
      - Which custom regex detection rules has my organization defined for Agent Handler?
      - Can I page through all the org-level pattern rules that block or redact data?
      instructions:
      - text: List all organization-wide custom regex rules.
      - text: Show page {page} of my org regex rules.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/security/custom-regex-rules/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization custom regex rule
      effect: write
      questions:
      - Can I add my own regex to detect sensitive data in tool calls across the whole organization?
      - What actions can an org-level regex rule take on inbound or outbound matches?
      instructions:
      - text: Create an org regex rule named {name} matching {regex}.
        slots:
          name: requestBody.name
          regex: requestBody.regex
      - text: Add organization rule {name} for pattern {regex} that does {outbound_action} on outbound matches.
        slots:
          name: requestBody.name
          regex: requestBody.regex
          outbound_action: requestBody.outbound_action
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/security/custom-regex-rules/{rule_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization custom regex rule
      effect: read
      questions:
      - What pattern and actions are configured on one of my org-level regex rules?
      - Can I look up a single organization detection rule by its ID?
      instructions:
      - text: Get org custom regex rule {rule_id}.
        slots:
          rule_id: path.rule_id
      - text: Show the settings of organization pattern rule {rule_id}.
        slots:
          rule_id: path.rule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/security/custom-regex-rules/{rule_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization custom regex rule
      effect: destructive
      questions:
      - Can I remove an organization-wide regex rule I no longer need?
      - Is deleting an org-level detection rule done by its rule ID?
      instructions:
      - text: Delete org custom regex rule {rule_id}.
        slots:
          rule_id: path.rule_id
      - text: Remove organization pattern rule {rule_id} permanently.
        slots:
          rule_id: path.rule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/security/custom-regex-rules/{rule_id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an organization custom regex rule
      effect: write
      questions:
      - Can I change the pattern of an org-level regex rule after creating it?
      - Is it possible to disable an organization detection rule without deleting it?
      instructions:
      - text: Change the pattern of org rule {rule_id} to {regex}.
        slots:
          rule_id: path.rule_id
          regex: requestBody.regex
      - text: Set org regex rule {rule_id} active status to {is_active}.
        slots:
          rule_id: path.rule_id
          is_active: requestBody.is_active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tool-packs/{tool_pack_id}/custom-regex-rules/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a tool pack's custom regex rules
      effect: read
      questions:
      - Which regex rules apply to a particular tool pack, including inherited org defaults?
      - Can I see only the rules defined on the tool pack itself rather than inherited ones?
      instructions:
      - text: List custom regex rules for tool pack {tool_pack_id}.
        slots:
          tool_pack_id: path.tool_pack_id
      - text: Show regex rules on tool pack {tool_pack_id} defined at {defined_at} level.
        slots:
          tool_pack_id: path.tool_pack_id
          defined_at: query.defined_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tool-packs/{tool_pack_id}/custom-regex-rules/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tool pack regex rule or override
      effect: write
      questions:
      - Can I override an organization regex rule for just one tool pack?
      - How do I add a detection pattern that applies only to a single tool pack?
      instructions:
      - text: Create rule {name} with pattern {regex} on tool pack {tool_pack_id}.
        slots:
          name: requestBody.name
          regex: requestBody.regex
          tool_pack_id: path.tool_pack_id
      - text: Override org rule {name} for tool pack {tool_pack_id} with inbound action {inbound_action}.
        slots:
          name: requestBody.name
          tool_pack_id: path.tool_pack_id
          inbound_action: requestBody.inbound_action
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tool-packs/{tool_pack_id}/custom-regex-rules/{rule_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tool pack's custom regex rule
      effect: read
      questions:
      - What does a specific regex rule look like inside one tool pack?
      - Can I fetch a tool-pack-level rule override by its ID?
      instructions:
      - text: Get regex rule {rule_id} in tool pack {tool_pack_id}.
        slots:
          rule_id: path.rule_id
          tool_pack_id: path.tool_pack_id
      - text: Show tool pack {tool_pack_id}'s rule {rule_id} settings.
        slots:
          rule_id: path.rule_id
          tool_pack_id: path.tool_pack_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tool-packs/{tool_pack_id}/custom-regex-rules/{rule_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tool pack regex rule or override
      effect: destructive
      questions:
      - If I delete a tool pack's override, does it revert to the organization default rule?
      - Can I permanently remove a regex rule that exists only on one tool pack?
      instructions:
      - text: Delete regex rule {rule_id} from tool pack {tool_pack_id}.
        slots:
          rule_id: path.rule_id
          tool_pack_id: path.tool_pack_id
      - text: Revert tool pack {tool_pack_id} rule {rule_id} to the org default.
        slots:
          rule_id: path.rule_id
          tool_pack_id: path.tool_pack_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tool-packs/{tool_pack_id}/custom-regex-rules/{rule_id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a tool pack's custom regex rule
      effect: write
      questions:
      - Can I change the confidence score of a regex rule for one tool pack only?
      - Which parts of a tool pack rule can I edit after it's created?
      instructions:
      - text: Set the score of rule {rule_id} in tool pack {tool_pack_id} to {score}.
        slots:
          rule_id: path.rule_id
          tool_pack_id: path.tool_pack_id
          score: requestBody.score
      - text: Update tool pack {tool_pack_id} rule {rule_id} context keywords to {context_keywords}.
        slots:
          rule_id: path.rule_id
          tool_pack_id: path.tool_pack_id
          context_keywords: requestBody.context_keywords
      method: generated
      generated: '2026-09-26'