Waiting for engine...
Skip to main content

API Control Plane Discovery Agent SDK changelog

Updated 

The API Control Plane Discovery Agent SDK changelog contains changes to the SDK by version and provides you with an audit trail. Releases containing only internal changes are omitted from the changelog.

Version 1.2.7​

17 October 2026

  • Added AuthenticationSettings and ApiKeySettings classes, and added corresponding authentication field to DiscoveredApi, Endpoint, and OpenProxyDeployResponse classes. The field can be set to provide information about how calls to an API or endpoint are authenticated.

  • Added organizationDisplayName and organizationEmail fields to ApplicationRpcRequest.

  • The agent SDK now supports API policy template discovery and assignment.

    note

    API policy template functionality is only compatible with an agent image with version 2026.9.7 or later.

    • New capabilities API_POLICY_TEMPLATE_DISCOVERY and API_POLICY_TEMPLATE_ASSIGNMENT can be reported if the agent implements API policy template interactions.
    • ApiPolicyTemplateDiscoveryHandler and ApiPolicyTemplateHandler can implement discovery and assignment, respectively. To use the functionality, the corresponding factories ApiPolicyTemplateDiscoveryHandlerFactory and ApiPolicyTemplateHandlerFactory must also be implemented, and must be returned by the implementation of new GatewayManager methods getApiPolicyTemplateDiscoveryHandlerFactory() and getApiPolicyTemplateHandlerFactory().
    • Added classes related to API policy template interactions: DiscoveredApiPolicyTemplate, ApiPolicyTemplateAssignment, ApiPolicyTemplateAssignmentRequest, ApiPolicyTemplateInfo
    • Added the apiPolicyTemplateAssignments field to DiscoveredApi to keep record of assignments of API policy templates to that API.

  • Added PARALLEL_API_SPEC_FETCHING capability. An agent can report PARALLEL_API_SPEC_FETCHING to indicate that the API Control Plane should fetch API specs in parallel during API discovery. The agent should only report this capability if the gateway can handle the load of fetching API specs in parallel.

  • Added GRAPHQL as an available ApiType in the v1.0 OpenProxySpec class.

    note

    The OPEN_PROXY_SPEC_DEPLOYMENT capability must be reported with version 3 or higher to use the deploy method of OpenProxySpecHandler with GRAPHQL type specifications. Using an ApiType of GRAPHQL will not work if version 2 is reported. This is the only change between version 2 and version 3 of the OPEN_PROXY_SPEC_DEPLOYMENT capability.

  • The example implementations ExampleApiPolicyTemplateDiscoveryHandler and ExampleApiPolicyTemplateHandler were added to the example package.

  • The existing example implementation of ApiDiscoveryHandler was updated to include new fields where applicable.

  • The existing example implementation of DiagnosticsService was updated to better reflect real usage by returning the original exception’s error, instead of overwriting it with a generic error message.