AgentGateway · OpenAPI Overlay 1.0.0

API Evangelist enrichment overlay for AgentGateway Admin / Debug Config Profiling API

4 actions 4 updates documentation extends openapi/agentgateway-profiling-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

operationIdexternalDocsx-admin-interfacex-config-schema

Targets 3

$.paths['/debug/pprof/profile'].get

$.paths['/debug/pprof/heap'].get

$.info

OpenAPI Overlay

generated: '2026-08-30'
method: generated
source: openapi/agentgateway-profiling-api-openapi.yml
overlay: 1.0.0
info:
  title: API Evangelist enrichment overlay for AgentGateway Admin / Debug Config Profiling API
  version: 1.0.0
extends: openapi/agentgateway-profiling-api-openapi.yml
actions:
- target: $.paths['/debug/pprof/profile'].get
  description: Assign a stable operationId and link the operation to its source documentation.
  update:
    operationId: getCpuProfile
    externalDocs:
      description: agentgateway documentation
      url: https://agentgateway.dev/docs/standalone/latest/operations/debug/#capture-profiles
- target: $.paths['/debug/pprof/heap'].get
  description: Assign a stable operationId and link the operation to its source documentation.
  update:
    operationId: getHeapProfile
    externalDocs:
      description: agentgateway documentation
      url: https://agentgateway.dev/docs/standalone/latest/operations/debug/#capture-profiles
- target: $.info
  description: Record that the admin interface is loopback-only and must not be exposed, as the agentgateway documentation
    states.
  update:
    x-admin-interface:
      bind: 127.0.0.1:15000
      configurable_via: adminAddr
      exposure: loopback-only
      warning: /config_dump discloses the full running configuration and /quitquitquit stops the proxy; both are
        unauthenticated to any caller that can open a connection.
      source: https://agentgateway.dev/docs/standalone/latest/operations/debug/
- target: $.info
  description: Link the first-party configuration JSON Schema that describes everything this admin API reports on.
  update:
    x-config-schema:
      url: https://agentgateway.dev/schema/config
      title: LocalConfig
      draft: 2020-12
      local: json-schema/agentgateway-config-schema.json