# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Aggregation Rules API
  version: 1.0.0
extends: openapi/harness-aggregationrules-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['/v1/aggregation-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List aggregation rules
      effect: read
      questions:
      - Which aggregation rules are defined in my developer portal?
      - Can I search aggregation rules by name?
      instructions:
      - text: List all aggregation rules.
      - text: Find aggregation rules matching {term}.
        slots:
          term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/aggregation-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an aggregation rule
      effect: write
      questions:
      - How do I create a rule that rolls up values across catalog entities?
      - What does an aggregation rule definition contain?
      instructions:
      - text: Create aggregation rule {rule}.
        slots:
          rule: requestBody.aggregation_rule
      - text: Add a new rule that aggregates scores to the team level.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/aggregation-rules/{aggregation-rule-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an aggregation rule
      effect: read
      questions:
      - Where can I see how one aggregation rule is configured?
      - What scopes does a specific aggregation rule target?
      instructions:
      - text: Get aggregation rule {id}.
        slots:
          id: path.aggregation-rule-id
      - text: Show the definition of aggregation rule {id}.
        slots:
          id: path.aggregation-rule-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/aggregation-rules/{aggregation-rule-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an aggregation rule
      effect: write
      questions:
      - Can I change the definition of an existing aggregation rule?
      - How do I edit an aggregation rule's configuration?
      instructions:
      - text: Update aggregation rule {id} with {rule}.
        slots:
          id: path.aggregation-rule-id
          rule: requestBody.aggregation_rule
      - text: Edit the configuration of aggregation rule {id}.
        slots:
          id: path.aggregation-rule-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/aggregation-rules/{aggregation-rule-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an aggregation rule
      effect: destructive
      questions:
      - How do I delete an aggregation rule?
      - Can I force-delete an aggregation rule that's still in use?
      instructions:
      - text: Delete aggregation rule {id}.
        slots:
          id: path.aggregation-rule-id
      - text: Force delete aggregation rule {id}.
        slots:
          id: path.aggregation-rule-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/aggregation-rules/review'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview which entities will hold aggregated values
      effect: read
      questions:
      - Before saving a rule, which entities would its aggregated values land on?
      - Can I preview aggregation targets for a set of scopes?
      instructions:
      - text: Review the aggregation targets for scopes {scopes} aggregated at {at}.
        slots:
          scopes: requestBody.scopes
          at: requestBody.scopes_to_aggregate_at
      - text: Preview which entities would receive values when aggregating at {at}.
        slots:
          at: requestBody.scopes_to_aggregate_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/aggregation-rules/{aggregation-rule-id}/compute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregation rule's computation now
      effect: write
      questions:
      - How do I recompute an aggregation rule immediately?
      - What happens if I trigger a computation while one is already running?
      instructions:
      - text: Trigger computation for aggregation rule {id}.
        slots:
          id: path.aggregation-rule-id
      - text: Recalculate the aggregated values for rule {id} now.
        slots:
          id: path.aggregation-rule-id
      method: generated
      generated: '2026-09-26'