HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Pipeline Management API v2 Egress Rules API

6 actions 6 updates phrasing extends openapi/here-egressrules-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for HERE's API. It is a proposal applied on top of the contract, not a document HERE publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v2/egressRules'].get

$.paths['/v2/egressRules'].post

$.paths['/v2/egressRules/{ruleId}'].get

$.paths['/v2/egressRules/{ruleId}'].delete

$.paths['/v2/egressRules/auditlog'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Pipeline Management API v2 Egress Rules API
  version: 1.0.0
extends: openapi/here-egressrules-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: 5
- target: $.paths['/v2/egressRules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a realm's egress rules
      effect: read
      questions:
      - Which outbound destinations are my pipelines allowed to reach?
      - How do I see all egress rules defined for my realm?
      instructions:
      - text: List all egress rules in my realm.
      - text: Show every allowed outbound destination for my pipelines.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/egressRules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create egress rules
      effect: write
      questions:
      - How do I allow my pipelines to call an external host by adding egress rules?
      - What happens if one of the egress rules I create already exists?
      instructions:
      - text: Create new egress rules for my realm.
      - text: Add egress rules atomically so pipelines can reach new external destinations.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/egressRules/{ruleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an egress rule
      effect: read
      questions:
      - How do I view the details of one egress rule?
      - What destination does a particular egress rule allow?
      instructions:
      - text: Get egress rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Show the destination allowed by egress rule {ruleId}.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/egressRules/{ruleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an egress rule
      effect: destructive
      questions:
      - How do I remove an egress rule so pipelines can no longer reach that host?
      - Who is allowed to delete egress rules in a realm?
      instructions:
      - text: Delete egress rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Revoke outbound access granted by rule {ruleId}.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/egressRules/auditlog'].get
  update:
    x-apievangelist-phrasing:
      intent: View the egress rules audit log
      effect: read
      questions:
      - Who created or deleted egress rules in my realm, and when?
      - Can I filter the egress audit log by destination or by the person who acted?
      instructions:
      - text: Show the egress rules audit log.
      - text: List audit entries for destination {ruleDestination} with action {action}.
        slots:
          ruleDestination: query.ruleDestination
          action: query.action
      - text: Show egress audit actions performed by {principal}.
        slots:
          principal: query.principal
      method: generated
      generated: '2026-09-26'