Skip to content
Registry StackDocsv0.41.0
Search

API references

View as Markdown

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 Evidence Gateway, Registry Casework, Registry Scheduling, and Registry Messaging when the selected docset contains those products. Generated operation pages inherit the source contract and must not be edited by hand.

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.