Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agent Handler Subpackage Standard Entity Rules API

8 actions 8 updates phrasing extends openapi/merge-subpackage-standardentityrules-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Merge's API. It is a proposal applied on top of the contract, not a document Merge publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/api/v1/security/standard-entity-rules/'].get
$.paths['/api/v1/security/standard-entity-rules/{entity_type}/'].get
$.paths['/api/v1/security/standard-entity-rules/{entity_type}/'].put
$.paths['/api/v1/tool-packs/{tool_pack_id}/standard-entity-rules/'].get
$.paths['/api/v1/tool-packs/{tool_pack_id}/standard-entity-rules/{entity_type}/'].get
$.paths['/api/v1/tool-packs/{tool_pack_id}/standard-entity-rules/{entity_type}/'].put
$.paths['/api/v1/tool-packs/{tool_pack_id}/standard-entity-rules/{entity_type}/'].delete

OpenAPI Overlay

Raw ↑ 
# 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 Standard Entity Rules API
  version: 1.0.0
extends: openapi/merge-subpackage-standardentityrules-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/v1/security/standard-entity-rules/'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization-wide sensitive data rules
      effect: read
      questions:
      - What standard entity rules apply across my whole organization?
      - Which data types are being blocked or redacted by default?
      instructions:
      - text: List my organization's standard entity rules.
      - text: Show page {page} of organization entity rules.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/security/standard-entity-rules/{entity_type}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization sensitive data rule
      effect: read
      questions:
      - How is a particular entity type handled org-wide by default?
      - What inbound and outbound action is set for one entity type at the org level?
      instructions:
      - text: Get the organization rule for entity type {entity_type}.
        slots:
          entity_type: path.entity_type
      - text: Show how {entity_type} is treated by default across my org.
        slots:
          entity_type: path.entity_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/security/standard-entity-rules/{entity_type}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an organization sensitive data rule
      effect: write
      questions:
      - How do I make the org redact a type of data coming in?
      - Can I switch an organization entity rule from log to block?
      instructions:
      - text: Set org rule {entity_type} to active {is_active}, inbound {inbound_action}, outbound {outbound_action}.
        slots:
          entity_type: path.entity_type
          is_active: requestBody.is_active
          inbound_action: requestBody.inbound_action
          outbound_action: requestBody.outbound_action
      - text: Across the organization, apply {inbound_action} inbound and {outbound_action} outbound to {entity_type}, active {is_active}.
        slots:
          entity_type: path.entity_type
          inbound_action: requestBody.inbound_action
          outbound_action: requestBody.outbound_action
          is_active: requestBody.is_active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tool-packs/{tool_pack_id}/standard-entity-rules/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a tool pack's sensitive data rules
      effect: read
      questions:
      - Which entity rules are in effect for one tool pack, including inherited defaults?
      - Can I see only the overrides defined on a tool pack?
      instructions:
      - text: List the entity rules for tool pack {tool_pack_id}.
        slots:
          tool_pack_id: path.tool_pack_id
      - text: Show entity rules on tool pack {tool_pack_id} defined at {defined_at}.
        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}/standard-entity-rules/{entity_type}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tool pack's rule for one entity type
      effect: read
      questions:
      - How does a specific tool pack treat a given sensitive entity type?
      - Does my tool pack override the org rule for a given data type?
      instructions:
      - text: Get tool pack {tool_pack_id}'s rule for {entity_type}.
        slots:
          tool_pack_id: path.tool_pack_id
          entity_type: path.entity_type
      - text: Check whether tool pack {tool_pack_id} overrides {entity_type}.
        slots:
          tool_pack_id: path.tool_pack_id
          entity_type: path.entity_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tool-packs/{tool_pack_id}/standard-entity-rules/{entity_type}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Override a sensitive data rule for a tool pack
      effect: write
      questions:
      - How do I give one tool pack a stricter rule than the organization default?
      - Can I create an entity rule override for a single tool pack?
      instructions:
      - text: 'Override {entity_type} on tool pack {tool_pack_id}: active {is_active}, inbound {inbound_action}, outbound {outbound_action}.'
        slots:
          entity_type: path.entity_type
          tool_pack_id: path.tool_pack_id
          is_active: requestBody.is_active
          inbound_action: requestBody.inbound_action
          outbound_action: requestBody.outbound_action
      - text: For tool pack {tool_pack_id} only, handle {entity_type} with {inbound_action} inbound and {outbound_action} outbound, active {is_active}.
        slots:
          tool_pack_id: path.tool_pack_id
          entity_type: path.entity_type
          inbound_action: requestBody.inbound_action
          outbound_action: requestBody.outbound_action
          is_active: requestBody.is_active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tool-packs/{tool_pack_id}/standard-entity-rules/{entity_type}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tool pack's sensitive data override
      effect: destructive
      questions:
      - How do I revert a tool pack to the organization's default entity rule?
      - Can I delete an entity rule override from a tool pack?
      instructions:
      - text: Delete the {entity_type} override on tool pack {tool_pack_id}.
        slots:
          entity_type: path.entity_type
          tool_pack_id: path.tool_pack_id
      - text: Revert tool pack {tool_pack_id} to org defaults for {entity_type}.
        slots:
          tool_pack_id: path.tool_pack_id
          entity_type: path.entity_type
      method: generated
      generated: '2026-09-26'