Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.44.0.
Maintained products publish their API contracts in the owning product section. Base Registry Engine (BReg) publishes its contract with its product reference.
Fixed generated APIs
Section titled “Fixed generated APIs”The documentation build renders committed OpenAPI contracts for Registry Evidence, Registry Casework, Registry Scheduling, and Registry Messaging when the selected docset contains those products, and the wallet-facing OID4VCI delivery contract of the supporting service beside Registry Evidence. Generated operation pages inherit the source contract and must not be edited by hand.
The build also renders the committed OpenAPI contract for Registry Coordinator.
The build also renders the committed OpenAPI contract for the Registry Document Store.
Base Registry Engine publishes its maintained API contract in the BReg API reference. Registry Render documents its input and service modes in its product guide.
Contract ownership
Section titled “Contract ownership”Each product owns its routes, authentication, request and response schemas, problem types, and compatibility policy. A client must use the reference for the product it calls.
Cookies on Registry Stack
We use optional cookies to understand how you use the main Registry Stack website and this documentation. If you contact us, we may link this activity to your enquiry. You can change your choice at any time. Read the privacy policy.
Your browser asks sites not to track you, so optional tracking stays off.
We could not use or save that choice. Optional tracking remains off.