Skip to content

Changelog and deprecation policy

Versioning

TrustNet exposes two RP-facing API surfaces:

Surface Base path Contract
RP machine plane https://rp.trustnet.app/api/rp/v1 rp.yaml
RP portal (management) https://me.trustnet.app/api/v1/rp rp-portal.yaml

The API version is part of the path. The OIDC endpoints follow the OIDC specification and are not versioned by TrustNet.

Documentation covers a single latest version. Versioned documentation archives are deferred until the first breaking API change.

What is a breaking change

Non-breaking (no action required):

  • adding an endpoint, an optional request field or response field;
  • adding a new claim or a new optional scope;
  • clarifying descriptions or error text without changing a code.

Breaking (new version required):

  • removing or renaming a field, endpoint, claim or error code;
  • changing a field's type or meaning;
  • changing the PPID derivation or the sub semantics;
  • changing token or consent behaviour in a way an existing RP must handle.

Breaking changes ship under a new path version (for example /api/rp/v2) with an overlap period; the old version keeps working during the overlap.

Deprecation policy

  • Deprecations are announced here and in the generated reference.
  • A deprecated API surface keeps working for at least 90 days after the announcement, except where a security issue requires faster action.
  • The announcement names the replacement and the removal date.
  • Removed surfaces return a clear error; they are not silently redirected to different semantics.

Changelog

2026-10-22 — Initial public documentation

  • Published the OIDC integration guide, concepts and how-to guides.
  • Added the endpoint, scope/claim and error-code reference.
  • Added generated references for the RP machine plane (rp.yaml) and the RP portal (rp-portal.yaml).
  • No public API changes yet.

The generated API reference reflects the OpenAPI documents in the same commit; a spec change is published on the next docs build.