Base Registry Engine configuration reference

Look up configuration keys for registry.yaml, module.yaml, and runtime.yaml. The tables are generated from Base Registry Engine’s Rust-derived JSON Schemas, including event conditions, webhook destinations, access profiles, and module extensions.

Scope

This reference describes the current configuration grammar, not a frozen contract. Types, required fields, accepted values, defaults, and constraints come from the schemas. Descriptions appear where the Rust definition supplies them. Internal compatibility fields and test-journey documents are outside this reference.

Use author a registry project for worked configurations and deployment steps. A schema-valid document still needs the compiler and runtime checks: bregctl check <project> validates the combined model; bregctl doctor --runtime-config <absolute-file> checks deployment configuration. Cross-field rules and references to other files cannot all be expressed by these tables.

Read the tables

fields[] means an array item; eventDestinations.* means a map entry whose name you choose. Required fields inside an optional object apply when that object is present. Conditional fields depend on the selected variant or another configuration value. Accepted values list the union across variants; constraints separated by or are alternatives. A schema default applies only where that variant declares it. Not specified does not mean that every value is accepted.

For example, events[].when.afterEquals.* holds a comparison value for a field you name. The schema permits a scalar or null; the compiler also checks that the value matches the declared field type and that the condition is valid for the event trigger.

Regeneration

The source schemas live under products/breg/generated/authoring/ and products/breg/generated/runtime/. Their owning generators are the authoring-schema and runtime-schema Rust examples. products/breg/scripts/check-generated.sh checks that they match the source types. Run npm run generate in docs/site to rebuild these tables from those schemas.

bregctl generate schemas <project> --output <directory> has a different purpose: it generates record schemas for that project’s API, not configuration schemas.

• registry.yaml Source preview, pre-1.0, 450 key paths
• modules/<name>/module.yaml Source preview, pre-1.0, 409 key paths
• runtime.yaml Source preview, pre-1.0, 89 key paths

registry.yaml

Source preview, pre-1.0

Generated from products/breg/generated/authoring/registry-project.schema.json. 450 key paths. Explained in docs/site/src/content/docs/configure/breg.mdx.

Key path	Type	Required	Accepted values	Constraints
accessProfiles	array	No	Not specifiedSchema default, where declared: []	None specified
accessProfiles[]Array item	object	No	Not specified	None specified
accessProfiles[].anonymous	boolean	No	Not specifiedSchema default, where declared: false	None specified
accessProfiles[].default	boolean	No	Not specifiedSchema default, where declared: false	None specified
accessProfiles[].grants	array	No	Not specifiedSchema default, where declared: []	None specified
accessProfiles[].grants[]Array item	object	No	Not specified	None specified
accessProfiles[].grants[].action	string	Conditional	Not specified	None specified
accessProfiles[].grants[].allowCount	boolean	Conditional	Not specifiedSchema default, where declared: false	None specified
accessProfiles[].grants[].allowDataExport	boolean	Conditional	Not specifiedSchema default, where declared: false	None specified
accessProfiles[].grants[].applyTargets	array	Conditional	Not specifiedSchema default, where declared: []	None specified
accessProfiles[].grants[].applyTargets[]Array item	object	Conditional	Not specified	None specified
accessProfiles[].grants[].applyTargets[].entity	string	Conditional	Not specified	None specified
accessProfiles[].grants[].applyTargets[].rowBoundariesExplicit row reach; an empty array intentionally permits all rows.	array	Conditional	Not specified	None specified
accessProfiles[].grants[].applyTargets[].rowBoundaries[]Array item	object	Conditional	Not specified	None specified
accessProfiles[].grants[].applyTargets[].rowBoundaries[].claim	string	Conditional	Not specified	None specified
accessProfiles[].grants[].applyTargets[].rowBoundaries[].field	string	Conditional	Not specified	None specified
accessProfiles[].grants[].applyTargets[].rowBoundaries[].operator	string	Conditional	equals in	None specified
accessProfiles[].grants[].entity	string	Conditional	Not specified	None specified
accessProfiles[].grants[].filterableFields	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
accessProfiles[].grants[].filterableFields[]Array item	string	Conditional	Not specified	None specified
accessProfiles[].grants[].lookups	array	Conditional	Not specifiedSchema default, where declared: []	None specified
accessProfiles[].grants[].lookups[]Array item	object	Conditional	Not specified	None specified
accessProfiles[].grants[].lookups[].claimMapping	object	Conditional	Not specifiedSchema default, where declared: {}	None specified
accessProfiles[].grants[].lookups[].claimMapping.*Map value	string	Conditional	Not specified	None specified
accessProfiles[].grants[].lookups[].selector	string	Conditional	Not specified	None specified
accessProfiles[].grants[].lookups[].valueOrigin	string	Conditional	request verified_claim	None specified
accessProfiles[].grants[].operations	array	Yes	Not specified	uniqueItems: true
accessProfiles[].grants[].operations[]Array item	string	No	apply_request approve_request batch cancel_request create get invoke list lookup patch reject_request request_revision revise_request revisions snapshot submit_request tombstone	None specified
accessProfiles[].grants[].readPaths	array	Conditional	Not specifiedSchema default, where declared: []	None specified
accessProfiles[].grants[].readPaths[]Array item	object	Conditional	Not specified	None specified
accessProfiles[].grants[].readPaths[].allowCount	boolean	Conditional	Not specifiedSchema default, where declared: false	None specified
accessProfiles[].grants[].readPaths[].filterableFields	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
accessProfiles[].grants[].readPaths[].filterableFields[]Array item	string	Conditional	Not specified	None specified
accessProfiles[].grants[].readPaths[].path	string	Conditional	Not specified	None specified
accessProfiles[].grants[].readPaths[].readableFields	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
accessProfiles[].grants[].readPaths[].readableFields[]Array item	string	Conditional	Not specified	None specified
accessProfiles[].grants[].readPaths[].sortableFields	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
accessProfiles[].grants[].readPaths[].sortableFields[]Array item	string	Conditional	Not specified	None specified
accessProfiles[].grants[].readableFields	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
accessProfiles[].grants[].readableFields[]Array item	string	Conditional	Not specified	None specified
accessProfiles[].grants[].requestPresence	array	Conditional	Not specifiedSchema default, where declared: []	None specified
accessProfiles[].grants[].requestPresence[]Array item	object	Conditional	Not specified	None specified
accessProfiles[].grants[].requestPresence[].requestType	string	Conditional	Not specified	None specified
accessProfiles[].grants[].requestPresence[].rowBoundariesExplicit row reach; an empty array intentionally permits all rows.	array	Conditional	Not specified	None specified
accessProfiles[].grants[].requestPresence[].rowBoundaries[]Array item	object	Conditional	Not specified	None specified
accessProfiles[].grants[].requestPresence[].rowBoundaries[].claim	string	Conditional	Not specified	None specified
accessProfiles[].grants[].requestPresence[].rowBoundaries[].field	string	Conditional	Not specified	None specified
accessProfiles[].grants[].requestPresence[].rowBoundaries[].operator	string	Conditional	equals in	None specified
accessProfiles[].grants[].requestVisibilityExpose only requests created by the current authenticated principal.	null | string	Conditional	owner Schema default, where declared: null	None specified
accessProfiles[].grants[].results	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
accessProfiles[].grants[].results[]Array item	string	Conditional	Not specified	None specified
accessProfiles[].grants[].reviewStages	array	Conditional	Not specifiedSchema default, where declared: []	None specified
accessProfiles[].grants[].reviewStages[]Array item	object	Conditional	Not specified	None specified
accessProfiles[].grants[].reviewStages[].stage	string	Conditional	Not specified	None specified
accessProfiles[].grants[].reviewStages[].targets	array	Conditional	Not specifiedSchema default, where declared: []	None specified
accessProfiles[].grants[].reviewStages[].targets[]Array item	object	Conditional	Not specified	None specified
accessProfiles[].grants[].reviewStages[].targets[].entity	string	Conditional	Not specified	None specified
accessProfiles[].grants[].reviewStages[].targets[].readableFields	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
accessProfiles[].grants[].reviewStages[].targets[].readableFields[]Array item	string	Conditional	Not specified	None specified
accessProfiles[].grants[].reviewStages[].targets[].rowBoundariesExplicit row reach; an empty array intentionally permits all rows.	array	Conditional	Not specified	None specified
accessProfiles[].grants[].reviewStages[].targets[].rowBoundaries[]Array item	object	Conditional	Not specified	None specified
accessProfiles[].grants[].reviewStages[].targets[].rowBoundaries[].claim	string	Conditional	Not specified	None specified
accessProfiles[].grants[].reviewStages[].targets[].rowBoundaries[].field	string	Conditional	Not specified	None specified
accessProfiles[].grants[].reviewStages[].targets[].rowBoundaries[].operator	string	Conditional	equals in	None specified
accessProfiles[].grants[].revisionAccess	boolean	Conditional	Not specifiedSchema default, where declared: false	None specified
accessProfiles[].grants[].rowBoundaries	array	Conditional	Not specified	None specified
accessProfiles[].grants[].rowBoundaries[]Array item	object	Conditional	Not specified	None specified
accessProfiles[].grants[].rowBoundaries[].claim	string	Conditional	Not specified	None specified
accessProfiles[].grants[].rowBoundaries[].field	string	Conditional	Not specified	None specified
accessProfiles[].grants[].rowBoundaries[].operator	string	Conditional	equals in	None specified
accessProfiles[].grants[].sortableFields	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
accessProfiles[].grants[].sortableFields[]Array item	string	Conditional	Not specified	None specified
accessProfiles[].grants[].spatialQueries	null | object	Conditional	Not specifiedSchema default, where declared: null	None specified
accessProfiles[].grants[].spatialQueries.bbox	null | object	Conditional	Not specified	None specified
accessProfiles[].grants[].spatialQueries.bbox.maximumLatitudeSpanDegrees	number	Conditional	Not specified	None specified
accessProfiles[].grants[].spatialQueries.bbox.maximumLongitudeSpanDegrees	number	Conditional	Not specified	None specified
accessProfiles[].grants[].targets	array	Conditional	Not specifiedSchema default, where declared: []	None specified
accessProfiles[].grants[].targets[]Array item	object	Conditional	Not specified	None specified
accessProfiles[].grants[].targets[].entity	string	Conditional	Not specified	None specified
accessProfiles[].grants[].targets[].rowBoundariesExplicit row reach; an empty array intentionally permits all rows.	array	Conditional	Not specified	None specified
accessProfiles[].grants[].targets[].rowBoundaries[]Array item	object	Conditional	Not specified	None specified
accessProfiles[].grants[].targets[].rowBoundaries[].claim	string	Conditional	Not specified	None specified
accessProfiles[].grants[].targets[].rowBoundaries[].field	string	Conditional	Not specified	None specified
accessProfiles[].grants[].targets[].rowBoundaries[].operator	string	Conditional	equals in	None specified
accessProfiles[].grants[].writableFields	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
accessProfiles[].grants[].writableFields[]Array item	string	Conditional	Not specified	None specified
accessProfiles[].id	string	Yes	Not specified	None specified
accessProfiles[].principalClaim	null | string	No	Not specifiedSchema default, where declared: null	None specified
accessProfiles[].requiredPurposesThe verified token's purpose must match one listed value. Empty means no purpose restriction.	array	No	Not specifiedSchema default, where declared: []	uniqueItems: true
accessProfiles[].requiredPurposes[]Array item	string	No	Not specified	None specified
accessProfiles[].requiredScopesAll listed scopes must be present in the verified token.	array	No	Not specifiedSchema default, where declared: []	uniqueItems: true
accessProfiles[].requiredScopes[]Array item	string	No	Not specified	None specified
actions	array	No	Not specified	None specified
actions[]Array item	object	No	Not specified	None specified
actions[].effects	array	No	Not specifiedSchema default, where declared: []	None specified
actions[].effects[]Array item	object	No	Not specified	None specified
actions[].effects[].clear	array	No	Not specifiedSchema default, where declared: []	uniqueItems: true
actions[].effects[].clear[]Array item	string	No	Not specified	None specified
actions[].effects[].id	null | string	No	Not specified	None specified
actions[].effects[].operation	string	Yes	apply_request approve_request batch cancel_request create get invoke list lookup patch reject_request request_revision revise_request revisions snapshot submit_request tombstone	None specified
actions[].effects[].set	object	No	Not specifiedSchema default, where declared: {}	None specified
actions[].effects[].set.*Map value	object	No	Not specified	None specified
actions[].effects[].set.*.fromEffect	null | string	No	Not specified	None specified
actions[].effects[].set.*.fromField	null | string	No	Not specified	None specified
actions[].effects[].target	object	Yes	Not specified	None specified
actions[].effects[].target.entity	null | string	No	Not specified	None specified
actions[].effects[].target.fromField	null | string	No	Not specified	None specified
actions[].id	string	Yes	Not specified	None specified
actions[].inputs	array	No	Not specifiedSchema default, where declared: []	None specified
actions[].inputs[]Array item	object	No	Not specified	None specified
actions[].inputs[].apiName	null | string	No	Not specified	None specified
actions[].inputs[].bbox	null | object	Conditional	Not specified	None specified
actions[].inputs[].bbox.east	string	Conditional	Not specified	None specified
actions[].inputs[].bbox.north	string	Conditional	Not specified	None specified
actions[].inputs[].bbox.south	string	Conditional	Not specified	None specified
actions[].inputs[].bbox.west	string	Conditional	Not specified	None specified
actions[].inputs[].classification	string	Yes	internal public restricted	None specified
actions[].inputs[].id	string	Yes	Not specified	None specified
actions[].inputs[].maxBytes	integer	Conditional	Not specified	format: uint32 minimum: 0
actions[].inputs[].maxLength	integer	Conditional	Not specified	format: uint32 minimum: 0
actions[].inputs[].maximum	null | string	Conditional	Not specified	None specified
actions[].inputs[].minLength	integer	Conditional	Not specifiedSchema default, where declared: 0	format: uint32 minimum: 0
actions[].inputs[].minimum	null | string	Conditional	Not specified	None specified
actions[].inputs[].onDelete	string	Conditional	restrict Schema default, where declared: "restrict"	None specified
actions[].inputs[].precision	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
actions[].inputs[].required	boolean	No	Not specifiedSchema default, where declared: false	None specified
actions[].inputs[].scale	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
actions[].inputs[].target	string	Conditional	Not specified	None specified
actions[].inputs[].type	string	Yes	boolean crs84-point date decimal int64 reference string structured text timestamp uuid vocabulary-code	None specified
actions[].inputs[].values	array	Conditional	Not specifiedSchema default, where declared: []	None specified
actions[].inputs[].values[]Array item	string	Conditional	Not specified	None specified
actions[].inputs[].vocabulary	string	Conditional	Not specified	None specified
apiVersion	string	Yes	Not specified	None specified
entities	array	No	Not specifiedSchema default, where declared: []	None specified
entities[]Array item	object	No	Not specified	None specified
entities[].accessRequirementsMandatory request-access requirements checked against every profile, including module contributions.	null | object	No	Not specified	None specified
entities[].accessRequirements.allowedPurposesWhen nonempty, every profile must restrict purpose to a nonempty subset of these values. Empty imposes no purpose requirement.	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].accessRequirements.allowedPurposes[]Array item	string	Conditional	Not specified	None specified
entities[].accessRequirements.requiredScopesEvery profile must require all these scopes. Requirements never grant access.	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].accessRequirements.requiredScopes[]Array item	string	Conditional	Not specified	None specified
entities[].accessRequirements.rowBoundariesEvery profile must include these exact field, verified-claim, and operator bindings.	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].accessRequirements.rowBoundaries[]Array item	object	Conditional	Not specified	None specified
entities[].accessRequirements.rowBoundaries[].claim	string	Conditional	Not specified	None specified
entities[].accessRequirements.rowBoundaries[].field	string	Conditional	Not specified	None specified
entities[].accessRequirements.rowBoundaries[].operator	string	Conditional	equals in	None specified
entities[].batch	null | object	No	Not specifiedSchema default, where declared: null	None specified
entities[].batch.maximumBytes	integer	Conditional	Not specified	format: uint32 minimum: 0
entities[].batch.maximumItems	integer	Conditional	Not specified	format: uint16 maximum: 65535 minimum: 0
entities[].changeControl	null | object	No	Not specified	None specified
entities[].changeControl.requiredFor	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].changeControl.requiredFor[]Array item	string	Conditional	apply_request approve_request batch cancel_request create get invoke list lookup patch reject_request request_revision revise_request revisions snapshot submit_request tombstone	None specified
entities[].changeRequest	null | object	No	Not specified	None specified
entities[].changeRequest.application	object	Conditional	Not specifiedSchema default, where declared: {"mode":"manual"}	None specified
entities[].changeRequest.application.allowedDispositions	array	Conditional	Not specified	uniqueItems: true
entities[].changeRequest.application.allowedDispositions[]Array item	string	Conditional	apply queue	None specified
entities[].changeRequest.application.mode	string	Conditional	automatic manual planner Schema default, where declared: "manual"	None specified
entities[].changeRequest.application.queueReasons	object	Conditional	Not specified	None specified
entities[].changeRequest.application.queueReasons.*Map value	string	Conditional	Not specified	None specified
entities[].changeRequest.effects	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].changeRequest.effects[]Array item	object	Conditional	Not specified	None specified
entities[].changeRequest.effects[].clear	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].changeRequest.effects[].clear[]Array item	string	Conditional	Not specified	None specified
entities[].changeRequest.effects[].id	null | string	Conditional	Not specified	None specified
entities[].changeRequest.effects[].operation	string	Conditional	apply_request approve_request batch cancel_request create get invoke list lookup patch reject_request request_revision revise_request revisions snapshot submit_request tombstone	None specified
entities[].changeRequest.effects[].set	object	Conditional	Not specifiedSchema default, where declared: {}	None specified
entities[].changeRequest.effects[].set.*Map value	object	Conditional	Not specified	None specified
entities[].changeRequest.effects[].set.*.fromEffect	null | string	Conditional	Not specified	None specified
entities[].changeRequest.effects[].set.*.fromField	null | string	Conditional	Not specified	None specified
entities[].changeRequest.effects[].target	object	Conditional	Not specified	None specified
entities[].changeRequest.effects[].target.entity	null | string	Conditional	Not specified	None specified
entities[].changeRequest.effects[].target.fromField	null | string	Conditional	Not specified	None specified
entities[].changeRequest.planner	null | object	Conditional	Not specified	None specified
entities[].changeRequest.planner.abi	string	Conditional	Not specified	None specified
entities[].changeRequest.planner.kind	string	Conditional	rhai	None specified
entities[].changeRequest.planner.requestFields	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].changeRequest.planner.requestFields[]Array item	string	Conditional	Not specified	None specified
entities[].changeRequest.planner.script	string	Conditional	Not specified	None specified
entities[].changeRequest.planner.writes	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].changeRequest.planner.writes[]Array item	object	Conditional	Not specified	None specified
entities[].changeRequest.planner.writes[].fields	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].changeRequest.planner.writes[].fields[]Array item	string	Conditional	Not specified	None specified
entities[].changeRequest.planner.writes[].operation	string	Conditional	apply_request approve_request batch cancel_request create get invoke list lookup patch reject_request request_revision revise_request revisions snapshot submit_request tombstone	None specified
entities[].changeRequest.planner.writes[].target	object	Conditional	Not specified	None specified
entities[].changeRequest.planner.writes[].target.entity	null | string	Conditional	Not specified	None specified
entities[].changeRequest.planner.writes[].target.fromField	null | string	Conditional	Not specified	None specified
entities[].changeRequest.retention	object	Conditional	Not specifiedSchema default, where declared: {"mode":"retain"}	None specified
entities[].changeRequest.retention.mode	string	Conditional	operator_erase retain Schema default, where declared: "retain"	None specified
entities[].changeRequest.review	object	Conditional	Not specified	None specified
entities[].changeRequest.review.mode	null | string	Conditional	none	None specified
entities[].changeRequest.review.stages	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].changeRequest.review.stages[]Array item	object	Conditional	Not specified	None specified
entities[].changeRequest.review.stages[].approvals	integer	Conditional	Not specified	format: uint16 maximum: 65535 minimum: 0
entities[].changeRequest.review.stages[].excludePreviousReviewersRefuse an actor who already decided another stage of this proposal version.	boolean	Conditional	Not specifiedSchema default, where declared: false	None specified
entities[].changeRequest.review.stages[].excludeSubmitter	boolean	Conditional	Not specifiedSchema default, where declared: false	None specified
entities[].changeRequest.review.stages[].id	string	Conditional	Not specified	None specified
entities[].classification	string	No	internal public restricted Schema default, where declared: "internal"	None specified
entities[].constraints	array	No	Not specifiedSchema default, where declared: []	None specified
entities[].constraints[]Array item	object	No	Not specified	None specified
entities[].constraints[].endField	null | string	Conditional	Not specifiedSchema default, where declared: null	None specified
entities[].constraints[].field	string	Conditional	Not specified	None specified
entities[].constraints[].fields	array	Conditional	Not specified	None specified
entities[].constraints[].fields[]Array item	string	Conditional	Not specified	None specified
entities[].constraints[].id	null | string	No	Not specifiedSchema default, where declared: null	None specified
entities[].constraints[].kind	string	Yes	compare int_range temporal-non-overlap unique vocabulary	None specified
entities[].constraints[].left	string	Conditional	Not specified	None specified
entities[].constraints[].maximum	integer | null	Conditional	Not specifiedSchema default, where declared: null	format: int64
entities[].constraints[].minimum	integer | null	Conditional	Not specifiedSchema default, where declared: null	format: int64
entities[].constraints[].operator	string	Conditional	greater_than greater_than_or_equal less_than less_than_or_equal	None specified
entities[].constraints[].right	string	Conditional	Not specified	None specified
entities[].constraints[].scopeFields	array	Conditional	Not specified	None specified
entities[].constraints[].scopeFields[]Array item	string	Conditional	Not specified	None specified
entities[].constraints[].startField	null | string	Conditional	Not specifiedSchema default, where declared: null	None specified
entities[].constraints[].values	array	Conditional	Not specified	None specified
entities[].constraints[].values[]Array item	string	Conditional	Not specified	None specified
entities[].constraints[].when	array | null	Conditional	Not specified	None specified
entities[].constraints[].when[]Array item	object	Conditional	Not specified	None specified
entities[].constraints[].when[].field	string	Conditional	Not specified	None specified
entities[].constraints[].when[].kind	string	Conditional	active_lifecycle field_equals field_is_not_null field_is_null	None specified
entities[].derived	array	No	Not specified	None specified
entities[].derived[]Array item	object	No	Not specified	None specified
entities[].derived[].execution	string	No	live Schema default, where declared: "live"	None specified
entities[].derived[].fields	array	No	Not specifiedSchema default, where declared: []	None specified
entities[].derived[].fields[]Array item	object	No	Not specified	None specified
entities[].derived[].fields[].apiName	null | string	No	Not specified	None specified
entities[].derived[].fields[].bbox	null | object	Conditional	Not specified	None specified
entities[].derived[].fields[].bbox.east	string	Conditional	Not specified	None specified
entities[].derived[].fields[].bbox.north	string	Conditional	Not specified	None specified
entities[].derived[].fields[].bbox.south	string	Conditional	Not specified	None specified
entities[].derived[].fields[].bbox.west	string	Conditional	Not specified	None specified
entities[].derived[].fields[].classification	string	Yes	internal public restricted	None specified
entities[].derived[].fields[].id	string	Yes	Not specified	None specified
entities[].derived[].fields[].maxBytes	integer	Conditional	Not specified	format: uint32 minimum: 0
entities[].derived[].fields[].maxLength	integer	Conditional	Not specified	format: uint32 minimum: 0
entities[].derived[].fields[].maximum	null | string	Conditional	Not specified	None specified
entities[].derived[].fields[].minLength	integer	Conditional	Not specifiedSchema default, where declared: 0	format: uint32 minimum: 0
entities[].derived[].fields[].minimum	null | string	Conditional	Not specified	None specified
entities[].derived[].fields[].onDelete	string	Conditional	restrict Schema default, where declared: "restrict"	None specified
entities[].derived[].fields[].precision	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
entities[].derived[].fields[].scale	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
entities[].derived[].fields[].target	string	Conditional	Not specified	None specified
entities[].derived[].fields[].type	string	Yes	boolean crs84-point date decimal int64 reference string structured text timestamp uuid vocabulary-code	None specified
entities[].derived[].fields[].values	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].derived[].fields[].values[]Array item	string	Conditional	Not specified	None specified
entities[].derived[].fields[].vocabulary	string	Conditional	Not specified	None specified
entities[].derived[].id	string	Yes	Not specified	None specified
entities[].derived[].key	string	Yes	Not specified	None specified
entities[].derived[].sql	string	Yes	Not specified	None specified
entities[].events	array	No	Not specifiedSchema default, where declared: []	None specified
entities[].events[]Array item	object	No	Not specified	None specified
entities[].events[].idStable event contract identifier, sent as ce-type. Use a new identifier for a breaking payload change.	string	Yes	Not specified	None specified
entities[].events[].projectionDeclared field identifiers to include in values. System event metadata is included separately.	array	Yes	Not specified	uniqueItems: true
entities[].events[].projection[]Array item	string	No	Not specified	None specified
entities[].events[].triggerCommitted record change that can produce this event.	string	Yes	created patched request_lifecycle tombstoned	None specified
entities[].events[].webhookLogical delivery destination. Production compilation requires a webhook.	null | object	No	Not specified	None specified
entities[].events[].webhook.destinationIdKey in runtime eventDestinations; the project carries no URL or secret.	string	Conditional	Not specified	None specified
entities[].events[].whenOptional field tests, combined with AND. Omit to emit on every matching trigger.	null | object	No	Not specified	None specified
entities[].events[].when.afterEqualsRequired values after the change. Valid with created and patched triggers.	object	Conditional	Not specifiedSchema default, where declared: {}	None specified
entities[].events[].when.afterEquals.*Map valueA comparison literal in the closed field-condition language. Objects and arrays are refused during source parsing. The compiler then validates each scalar against the declared Registry field type.	boolean | null | number | string	Conditional	Not specified	None specified
entities[].events[].when.beforeEqualsRequired values before the change. Valid with patched and tombstoned triggers.	object	Conditional	Not specifiedSchema default, where declared: {}	None specified
entities[].events[].when.beforeEquals.*Map valueA comparison literal in the closed field-condition language. Objects and arrays are refused during source parsing. The compiler then validates each scalar against the declared Registry field type.	boolean | null | number | string	Conditional	Not specified	None specified
entities[].events[].when.changedFields whose values must change. Only valid with the patched trigger.	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].events[].when.changed[]Array item	string	Conditional	Not specified	None specified
entities[].events[].when.kind	string	Conditional	fields request_lifecycle	None specified
entities[].events[].when.stages	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].events[].when.stages[]Array item	string	Conditional	Not specified	None specified
entities[].events[].when.toStates	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].events[].when.toStates[]Array item	string	Conditional	Not specified	None specified
entities[].events[].when.transitions	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].events[].when.transitions[]Array item	string	Conditional	Not specified	None specified
entities[].fields	array	No	Not specifiedSchema default, where declared: []	None specified
entities[].fields[]Array item	object	No	Not specified	None specified
entities[].fields[].apiName	null | string	No	Not specifiedSchema default, where declared: null	None specified
entities[].fields[].bbox	null | object	Conditional	Not specifiedSchema default, where declared: null	None specified
entities[].fields[].bbox.east	string	Conditional	Not specified	None specified
entities[].fields[].bbox.north	string	Conditional	Not specified	None specified
entities[].fields[].bbox.south	string	Conditional	Not specified	None specified
entities[].fields[].bbox.west	string	Conditional	Not specified	None specified
entities[].fields[].classification	string	Yes	internal public restricted	None specified
entities[].fields[].id	string	Yes	Not specified	None specified
entities[].fields[].maxBytes	integer	Conditional	Not specified	format: uint32 minimum: 0
entities[].fields[].maxLength	integer	Conditional	Not specified	format: uint32 minimum: 0
entities[].fields[].maximum	null | string	Conditional	Not specifiedSchema default, where declared: null	None specified
entities[].fields[].minLength	integer	Conditional	Not specifiedSchema default, where declared: 0	format: uint32 minimum: 0
entities[].fields[].minimum	null | string	Conditional	Not specifiedSchema default, where declared: null	None specified
entities[].fields[].onDelete	string	Conditional	restrict Schema default, where declared: "restrict"	None specified
entities[].fields[].precision	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
entities[].fields[].required	boolean	No	Not specifiedSchema default, where declared: false	None specified
entities[].fields[].scale	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
entities[].fields[].target	string	Conditional	Not specified	None specified
entities[].fields[].type	string	Yes	boolean crs84-point date decimal int64 reference string structured text timestamp uuid vocabulary-code	None specified
entities[].fields[].validTimeRole	null | string	No	valid_from valid_to Schema default, where declared: null	None specified
entities[].fields[].values	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].fields[].values[]Array item	string	Conditional	Not specified	None specified
entities[].fields[].vocabulary	string	Conditional	Not specified	None specified
entities[].geojson	null | object	No	Not specified	None specified
entities[].geojson.geometryField	string	Conditional	Not specified	None specified
entities[].id	string	Yes	Not specified	None specified
entities[].indexes	array	No	Not specifiedSchema default, where declared: []	None specified
entities[].indexes[]Array item	object	No	Not specified	None specified
entities[].indexes[].fields	array	Yes	Not specified	None specified
entities[].indexes[].fields[]Array item	string	No	Not specified	None specified
entities[].indexes[].id	string	Yes	Not specified	None specified
entities[].mutationMode	string	Yes	create_only mutable	None specified
entities[].primaryDataset	string	Yes	Not specified	None specified
entities[].readPaths	array	No	Not specified	None specified
entities[].readPaths[]Array item	object	No	Not specified	None specified
entities[].readPaths[].id	string	Yes	Not specified	None specified
entities[].readPaths[].route	string	Yes	Not specified	None specified
entities[].readPaths[].through	string	Yes	Not specified	None specified
entities[].readPaths[].to	string	Yes	Not specified	None specified
entities[].route	string	Yes	Not specified	None specified
entities[].selectorProfiles	array	No	Not specified	None specified
entities[].selectorProfiles[]Array item	object	No	Not specified	None specified
entities[].selectorProfiles[].fields	array	Yes	Not specified	None specified
entities[].selectorProfiles[].fields[]Array item	string	No	Not specified	None specified
entities[].selectorProfiles[].id	string	Yes	Not specified	None specified
entities[].temporal	null | object	No	Not specifiedSchema default, where declared: null	None specified
entities[].temporal.endField	string	Conditional	Not specified	None specified
entities[].temporal.scopeFieldsDeprecated bounded predecessor bridge. New authoring should declare exclusivity only through constraints[].scopeFields.	array	Conditional	Not specified	None specified
entities[].temporal.scopeFields[]Array item	string	Conditional	Not specified	None specified
entities[].temporal.startField	string	Conditional	Not specified	None specified
entities[].tombstone	boolean	No	Not specifiedSchema default, where declared: false	None specified
kind	string	Yes	Not specified	None specified
manifestProjection	null | object	No	Not specifiedSchema default, where declared: null	None specified
manifestProjection.accessProfile	string	Conditional	Not specified	None specified
manifestProjection.catalog	object	Conditional	Not specified	None specified
manifestProjection.catalog.applicationProfiles	array	Conditional	Not specifiedSchema default, where declared: []	None specified
manifestProjection.catalog.applicationProfiles[]Array item	object	Conditional	Not specified	None specified
manifestProjection.catalog.applicationProfiles[].id	string	Conditional	Not specified	None specified
manifestProjection.catalog.applicationProfiles[].version	string	Conditional	Not specified	None specified
manifestProjection.catalog.baseUrl	string	Conditional	Not specified	None specified
manifestProjection.catalog.conformsTo	array	Conditional	Not specifiedSchema default, where declared: []	None specified
manifestProjection.catalog.conformsTo[]Array item	string	Conditional	Not specified	None specified
manifestProjection.catalog.description	null | object | string	Conditional	Not specified	None specified
manifestProjection.catalog.description.*Map value	string	Conditional	Not specified	None specified
manifestProjection.catalog.participantId	null | string	Conditional	Not specified	None specified
manifestProjection.catalog.publisher	object	Conditional	Not specified	None specified
manifestProjection.catalog.publisher.authorityType	null | string	Conditional	Not specified	None specified
manifestProjection.catalog.publisher.id	string	Conditional	Not specified	None specified
manifestProjection.catalog.publisher.iri	null | string	Conditional	Not specified	None specified
manifestProjection.catalog.publisher.name	string	Conditional	Not specified	None specified
manifestProjection.catalog.standards	object	Conditional	Not specifiedSchema default, where declared: {}	None specified
manifestProjection.catalog.standards.dcat	null | string	Conditional	Not specified	None specified
manifestProjection.catalog.standards.jsonSchema	null | string	Conditional	Not specified	None specified
manifestProjection.catalog.standards.shacl	null | string	Conditional	Not specified	None specified
manifestProjection.catalog.title	object | string	Conditional	Not specified	None specified
manifestProjection.catalog.title.*Map value	string	Conditional	Not specified	None specified
manifestProjection.classificationCeiling	string	Conditional	internal public restricted	None specified
manifestProjection.dataServices	array	Conditional	Not specified	None specified
manifestProjection.dataServices[]Array item	object	Conditional	Not specified	None specified
manifestProjection.dataServices[].conformsTo	null | string	Conditional	Not specified	None specified
manifestProjection.dataServices[].description	null | object | string	Conditional	Not specified	None specified
manifestProjection.dataServices[].description.*Map value	string	Conditional	Not specified	None specified
manifestProjection.dataServices[].endpointDescription	null | string	Conditional	Not specified	None specified
manifestProjection.dataServices[].endpointUrl	string	Conditional	Not specified	None specified
manifestProjection.dataServices[].id	string	Conditional	Not specified	None specified
manifestProjection.dataServices[].iri	null | string	Conditional	Not specified	None specified
manifestProjection.dataServices[].servesDatasets	array	Conditional	Not specified	None specified
manifestProjection.dataServices[].servesDatasets[]Array item	string	Conditional	Not specified	None specified
manifestProjection.dataServices[].title	object | string	Conditional	Not specified	None specified
manifestProjection.dataServices[].title.*Map value	string	Conditional	Not specified	None specified
manifestProjection.datasets	array	Conditional	Not specified	None specified
manifestProjection.datasets[]Array item	object	Conditional	Not specified	None specified
manifestProjection.datasets[].accessProfile	null | string	Conditional	Not specified	None specified
manifestProjection.datasets[].applicableLegislation	array	Conditional	Not specifiedSchema default, where declared: []	None specified
manifestProjection.datasets[].applicableLegislation[]Array item	string	Conditional	Not specified	None specified
manifestProjection.datasets[].classificationCeiling	null | string	Conditional	internal public restricted	None specified
manifestProjection.datasets[].conformsTo	array	Conditional	Not specifiedSchema default, where declared: []	None specified
manifestProjection.datasets[].conformsTo[]Array item	string	Conditional	Not specified	None specified
manifestProjection.datasets[].description	null | object | string	Conditional	Not specified	None specified
manifestProjection.datasets[].description.*Map value	string	Conditional	Not specified	None specified
manifestProjection.datasets[].id	string	Conditional	Not specified	None specified
manifestProjection.datasets[].iri	null | string	Conditional	Not specified	None specified
manifestProjection.datasets[].owner	null | string	Conditional	Not specified	None specified
manifestProjection.datasets[].spatialCoverage	null | string	Conditional	Not specified	None specified
manifestProjection.datasets[].status	null | string	Conditional	active completed deprecated under_development withdrawn	None specified
manifestProjection.datasets[].title	object | string	Conditional	Not specified	None specified
manifestProjection.datasets[].title.*Map value	string	Conditional	Not specified	None specified
manifestProjection.datasets[].version	null | string	Conditional	Not specified	None specified
manifestProjection.distributions	array	Conditional	Not specified	None specified
manifestProjection.distributions[]Array item	object	Conditional	Not specified	None specified
manifestProjection.distributions[].accessService	null | string	Conditional	Not specified	None specified
manifestProjection.distributions[].accessUrl	null | string	Conditional	Not specified	None specified
manifestProjection.distributions[].dataset	string	Conditional	Not specified	None specified
manifestProjection.distributions[].description	null | object | string	Conditional	Not specified	None specified
manifestProjection.distributions[].description.*Map value	string	Conditional	Not specified	None specified
manifestProjection.distributions[].downloadUrl	null | string	Conditional	Not specified	None specified
manifestProjection.distributions[].format	null | string	Conditional	Not specified	None specified
manifestProjection.distributions[].id	string	Conditional	Not specified	None specified
manifestProjection.distributions[].iri	null | string	Conditional	Not specified	None specified
manifestProjection.distributions[].mediaType	null | string	Conditional	Not specified	None specified
manifestProjection.distributions[].title	null | object | string	Conditional	Not specified	None specified
manifestProjection.distributions[].title.*Map value	string	Conditional	Not specified	None specified
manifestProjection.entities	array	Conditional	Not specifiedSchema default, where declared: []	None specified
manifestProjection.entities[]Array item	object	Conditional	Not specified	None specified
manifestProjection.entities[].conceptUri	null | string	Conditional	Not specified	None specified
manifestProjection.entities[].description	null | object | string	Conditional	Not specified	None specified
manifestProjection.entities[].description.*Map value	string	Conditional	Not specified	None specified
manifestProjection.entities[].fields	array	Conditional	Not specifiedSchema default, where declared: []	None specified
manifestProjection.entities[].fields[]Array item	object	Conditional	Not specified	None specified
manifestProjection.entities[].fields[].concepts	array	Conditional	Not specifiedSchema default, where declared: []	None specified
manifestProjection.entities[].fields[].concepts[]Array item	string	Conditional	Not specified	None specified
manifestProjection.entities[].fields[].id	string	Conditional	Not specified	None specified
manifestProjection.entities[].fields[].language	null | string	Conditional	Not specified	None specified
manifestProjection.entities[].fields[].relationshipConceptUri	null | string	Conditional	Not specified	None specified
manifestProjection.entities[].fields[].relationshipRole	null | string	Conditional	Not specified	None specified
manifestProjection.entities[].fields[].unit	null | string	Conditional	Not specified	None specified
manifestProjection.entities[].id	string	Conditional	Not specified	None specified
manifestProjection.entities[].identifiers	array	Conditional	Not specifiedSchema default, where declared: []	None specified
manifestProjection.entities[].identifiers[]Array item	object	Conditional	Not specified	None specified
manifestProjection.entities[].identifiers[].field	string	Conditional	Not specified	None specified
manifestProjection.entities[].identifiers[].kind	string	Conditional	Not specified	None specified
manifestProjection.entities[].title	null | object | string	Conditional	Not specified	None specified
manifestProjection.entities[].title.*Map value	string	Conditional	Not specified	None specified
manifestProjection.publicService	object	Conditional	Not specified	None specified
manifestProjection.publicService.id	string	Conditional	Not specified	None specified
manifestProjection.publicService.title	object | string	Conditional	Not specified	None specified
manifestProjection.publicService.title.*Map value	string	Conditional	Not specified	None specified
manifestProjection.vocabularies	array	Conditional	Not specifiedSchema default, where declared: []	None specified
manifestProjection.vocabularies[]Array item	object	Conditional	Not specified	None specified
manifestProjection.vocabularies[].concepts	array	Conditional	Not specifiedSchema default, where declared: []	None specified
manifestProjection.vocabularies[].concepts[]Array item	object	Conditional	Not specified	None specified
manifestProjection.vocabularies[].concepts[].code	string	Conditional	Not specified	None specified
manifestProjection.vocabularies[].concepts[].iri	null | string	Conditional	Not specified	None specified
manifestProjection.vocabularies[].concepts[].label	null | object | string	Conditional	Not specified	None specified
manifestProjection.vocabularies[].concepts[].label.*Map value	string	Conditional	Not specified	None specified
manifestProjection.vocabularies[].externalRef	null | string	Conditional	Not specified	None specified
manifestProjection.vocabularies[].id	string	Conditional	Not specified	None specified
manifestProjection.vocabularies[].schemeIri	string	Conditional	Not specified	None specified
manifestProjection.vocabularies[].version	null | string	Conditional	Not specified	None specified
modules	array	No	Not specifiedSchema default, where declared: []	None specified
modules[]Array item	object	No	Not specified	None specified
modules[].digest	null | string	No	Not specifiedSchema default, where declared: null	None specified
modules[].id	string	Yes	Not specified	None specified
modules[].version	string	Yes	Not specified	None specified
package	null | object	No	Not specifiedSchema default, where declared: null	None specified
package.environment	string	Conditional	Not specified	None specified
package.instanceId	string	Conditional	Not specified	None specified
package.sequence	integer	Conditional	Not specified	format: uint64 minimum: 0
package.sourceRevision	string	Conditional	Not specified	None specified
registry	object	Yes	Not specified	None specified
registry.canonicalBaseIri	string	Yes	Not specified	None specified
registry.defaultLanguage	string	Yes	Not specified	None specified
registry.id	string	Yes	Not specified	None specified
registry.version	string	Yes	Not specified	None specified
vocabularies	array	No	Not specifiedSchema default, where declared: []	None specified
vocabularies[]Array item	object	No	Not specified	None specified
vocabularies[].id	string	Yes	Not specified	None specified
vocabularies[].values	array	Yes	Not specified	None specified
vocabularies[].values[]Array item	string	No	Not specified	None specified

modules/<name>/module.yaml

Source preview, pre-1.0

Generated from products/breg/generated/authoring/registry-module.schema.json. 409 key paths. Explained in docs/site/src/content/docs/configure/breg.mdx.

Key path	Type	Required	Accepted values	Constraints
actionsNamed immediate actions introduced by this module.	array	No	Not specified	None specified
actions[]Array item	object	No	Not specified	None specified
actions[].effects	array	No	Not specifiedSchema default, where declared: []	None specified
actions[].effects[]Array item	object	No	Not specified	None specified
actions[].effects[].clear	array	No	Not specifiedSchema default, where declared: []	uniqueItems: true
actions[].effects[].clear[]Array item	string	No	Not specified	None specified
actions[].effects[].id	null | string	No	Not specified	None specified
actions[].effects[].operation	string	Yes	apply_request approve_request batch cancel_request create get invoke list lookup patch reject_request request_revision revise_request revisions snapshot submit_request tombstone	None specified
actions[].effects[].set	object	No	Not specifiedSchema default, where declared: {}	None specified
actions[].effects[].set.*Map value	object	No	Not specified	None specified
actions[].effects[].set.*.fromEffect	null | string	No	Not specified	None specified
actions[].effects[].set.*.fromField	null | string	No	Not specified	None specified
actions[].effects[].target	object	Yes	Not specified	None specified
actions[].effects[].target.entity	null | string	No	Not specified	None specified
actions[].effects[].target.fromField	null | string	No	Not specified	None specified
actions[].id	string	Yes	Not specified	None specified
actions[].inputs	array	No	Not specifiedSchema default, where declared: []	None specified
actions[].inputs[]Array item	object	No	Not specified	None specified
actions[].inputs[].apiName	null | string	No	Not specified	None specified
actions[].inputs[].bbox	null | object	Conditional	Not specified	None specified
actions[].inputs[].bbox.east	string	Conditional	Not specified	None specified
actions[].inputs[].bbox.north	string	Conditional	Not specified	None specified
actions[].inputs[].bbox.south	string	Conditional	Not specified	None specified
actions[].inputs[].bbox.west	string	Conditional	Not specified	None specified
actions[].inputs[].classification	string	Yes	internal public restricted	None specified
actions[].inputs[].id	string	Yes	Not specified	None specified
actions[].inputs[].maxBytes	integer	Conditional	Not specified	format: uint32 minimum: 0
actions[].inputs[].maxLength	integer	Conditional	Not specified	format: uint32 minimum: 0
actions[].inputs[].maximum	null | string	Conditional	Not specified	None specified
actions[].inputs[].minLength	integer	Conditional	Not specifiedSchema default, where declared: 0	format: uint32 minimum: 0
actions[].inputs[].minimum	null | string	Conditional	Not specified	None specified
actions[].inputs[].onDelete	string	Conditional	restrict Schema default, where declared: "restrict"	None specified
actions[].inputs[].precision	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
actions[].inputs[].required	boolean	No	Not specifiedSchema default, where declared: false	None specified
actions[].inputs[].scale	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
actions[].inputs[].target	string	Conditional	Not specified	None specified
actions[].inputs[].type	string	Yes	boolean crs84-point date decimal int64 reference string structured text timestamp uuid vocabulary-code	None specified
actions[].inputs[].values	array	Conditional	Not specifiedSchema default, where declared: []	None specified
actions[].inputs[].values[]Array item	string	Conditional	Not specified	None specified
actions[].inputs[].vocabulary	string	Conditional	Not specified	None specified
dependenciesIdentifiers of modules that must be applied before this module.	array	No	Not specifiedSchema default, where declared: []	None specified
dependencies[]Array item	string	No	Not specified	None specified
entitiesEntities introduced by this module.	array	No	Not specifiedSchema default, where declared: []	None specified
entities[]Array item	object	No	Not specified	None specified
entities[].accessRequirementsMandatory request-access requirements checked against every profile, including module contributions.	null | object	No	Not specified	None specified
entities[].accessRequirements.allowedPurposesWhen nonempty, every profile must restrict purpose to a nonempty subset of these values. Empty imposes no purpose requirement.	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].accessRequirements.allowedPurposes[]Array item	string	Conditional	Not specified	None specified
entities[].accessRequirements.requiredScopesEvery profile must require all these scopes. Requirements never grant access.	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].accessRequirements.requiredScopes[]Array item	string	Conditional	Not specified	None specified
entities[].accessRequirements.rowBoundariesEvery profile must include these exact field, verified-claim, and operator bindings.	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].accessRequirements.rowBoundaries[]Array item	object	Conditional	Not specified	None specified
entities[].accessRequirements.rowBoundaries[].claim	string	Conditional	Not specified	None specified
entities[].accessRequirements.rowBoundaries[].field	string	Conditional	Not specified	None specified
entities[].accessRequirements.rowBoundaries[].operator	string	Conditional	equals in	None specified
entities[].batch	null | object	No	Not specifiedSchema default, where declared: null	None specified
entities[].batch.maximumBytes	integer	Conditional	Not specified	format: uint32 minimum: 0
entities[].batch.maximumItems	integer	Conditional	Not specified	format: uint16 maximum: 65535 minimum: 0
entities[].changeControl	null | object	No	Not specified	None specified
entities[].changeControl.requiredFor	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].changeControl.requiredFor[]Array item	string	Conditional	apply_request approve_request batch cancel_request create get invoke list lookup patch reject_request request_revision revise_request revisions snapshot submit_request tombstone	None specified
entities[].changeRequest	null | object	No	Not specified	None specified
entities[].changeRequest.application	object	Conditional	Not specifiedSchema default, where declared: {"mode":"manual"}	None specified
entities[].changeRequest.application.allowedDispositions	array	Conditional	Not specified	uniqueItems: true
entities[].changeRequest.application.allowedDispositions[]Array item	string	Conditional	apply queue	None specified
entities[].changeRequest.application.mode	string	Conditional	automatic manual planner Schema default, where declared: "manual"	None specified
entities[].changeRequest.application.queueReasons	object	Conditional	Not specified	None specified
entities[].changeRequest.application.queueReasons.*Map value	string	Conditional	Not specified	None specified
entities[].changeRequest.effects	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].changeRequest.effects[]Array item	object	Conditional	Not specified	None specified
entities[].changeRequest.effects[].clear	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].changeRequest.effects[].clear[]Array item	string	Conditional	Not specified	None specified
entities[].changeRequest.effects[].id	null | string	Conditional	Not specified	None specified
entities[].changeRequest.effects[].operation	string	Conditional	apply_request approve_request batch cancel_request create get invoke list lookup patch reject_request request_revision revise_request revisions snapshot submit_request tombstone	None specified
entities[].changeRequest.effects[].set	object	Conditional	Not specifiedSchema default, where declared: {}	None specified
entities[].changeRequest.effects[].set.*Map value	object	Conditional	Not specified	None specified
entities[].changeRequest.effects[].set.*.fromEffect	null | string	Conditional	Not specified	None specified
entities[].changeRequest.effects[].set.*.fromField	null | string	Conditional	Not specified	None specified
entities[].changeRequest.effects[].target	object	Conditional	Not specified	None specified
entities[].changeRequest.effects[].target.entity	null | string	Conditional	Not specified	None specified
entities[].changeRequest.effects[].target.fromField	null | string	Conditional	Not specified	None specified
entities[].changeRequest.planner	null | object	Conditional	Not specified	None specified
entities[].changeRequest.planner.abi	string	Conditional	Not specified	None specified
entities[].changeRequest.planner.kind	string	Conditional	rhai	None specified
entities[].changeRequest.planner.requestFields	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].changeRequest.planner.requestFields[]Array item	string	Conditional	Not specified	None specified
entities[].changeRequest.planner.script	string	Conditional	Not specified	None specified
entities[].changeRequest.planner.writes	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].changeRequest.planner.writes[]Array item	object	Conditional	Not specified	None specified
entities[].changeRequest.planner.writes[].fields	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].changeRequest.planner.writes[].fields[]Array item	string	Conditional	Not specified	None specified
entities[].changeRequest.planner.writes[].operation	string	Conditional	apply_request approve_request batch cancel_request create get invoke list lookup patch reject_request request_revision revise_request revisions snapshot submit_request tombstone	None specified
entities[].changeRequest.planner.writes[].target	object	Conditional	Not specified	None specified
entities[].changeRequest.planner.writes[].target.entity	null | string	Conditional	Not specified	None specified
entities[].changeRequest.planner.writes[].target.fromField	null | string	Conditional	Not specified	None specified
entities[].changeRequest.retention	object	Conditional	Not specifiedSchema default, where declared: {"mode":"retain"}	None specified
entities[].changeRequest.retention.mode	string	Conditional	operator_erase retain Schema default, where declared: "retain"	None specified
entities[].changeRequest.review	object	Conditional	Not specified	None specified
entities[].changeRequest.review.mode	null | string	Conditional	none	None specified
entities[].changeRequest.review.stages	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].changeRequest.review.stages[]Array item	object	Conditional	Not specified	None specified
entities[].changeRequest.review.stages[].approvals	integer	Conditional	Not specified	format: uint16 maximum: 65535 minimum: 0
entities[].changeRequest.review.stages[].excludePreviousReviewersRefuse an actor who already decided another stage of this proposal version.	boolean	Conditional	Not specifiedSchema default, where declared: false	None specified
entities[].changeRequest.review.stages[].excludeSubmitter	boolean	Conditional	Not specifiedSchema default, where declared: false	None specified
entities[].changeRequest.review.stages[].id	string	Conditional	Not specified	None specified
entities[].classification	string	No	internal public restricted Schema default, where declared: "internal"	None specified
entities[].constraints	array	No	Not specifiedSchema default, where declared: []	None specified
entities[].constraints[]Array item	object	No	Not specified	None specified
entities[].constraints[].endField	null | string	Conditional	Not specifiedSchema default, where declared: null	None specified
entities[].constraints[].field	string	Conditional	Not specified	None specified
entities[].constraints[].fields	array	Conditional	Not specified	None specified
entities[].constraints[].fields[]Array item	string	Conditional	Not specified	None specified
entities[].constraints[].id	null | string	No	Not specifiedSchema default, where declared: null	None specified
entities[].constraints[].kind	string	Yes	compare int_range temporal-non-overlap unique vocabulary	None specified
entities[].constraints[].left	string	Conditional	Not specified	None specified
entities[].constraints[].maximum	integer | null	Conditional	Not specifiedSchema default, where declared: null	format: int64
entities[].constraints[].minimum	integer | null	Conditional	Not specifiedSchema default, where declared: null	format: int64
entities[].constraints[].operator	string	Conditional	greater_than greater_than_or_equal less_than less_than_or_equal	None specified
entities[].constraints[].right	string	Conditional	Not specified	None specified
entities[].constraints[].scopeFields	array	Conditional	Not specified	None specified
entities[].constraints[].scopeFields[]Array item	string	Conditional	Not specified	None specified
entities[].constraints[].startField	null | string	Conditional	Not specifiedSchema default, where declared: null	None specified
entities[].constraints[].values	array	Conditional	Not specified	None specified
entities[].constraints[].values[]Array item	string	Conditional	Not specified	None specified
entities[].constraints[].when	array | null	Conditional	Not specified	None specified
entities[].constraints[].when[]Array item	object	Conditional	Not specified	None specified
entities[].constraints[].when[].field	string	Conditional	Not specified	None specified
entities[].constraints[].when[].kind	string	Conditional	active_lifecycle field_equals field_is_not_null field_is_null	None specified
entities[].derived	array	No	Not specified	None specified
entities[].derived[]Array item	object	No	Not specified	None specified
entities[].derived[].execution	string	No	live Schema default, where declared: "live"	None specified
entities[].derived[].fields	array	No	Not specifiedSchema default, where declared: []	None specified
entities[].derived[].fields[]Array item	object	No	Not specified	None specified
entities[].derived[].fields[].apiName	null | string	No	Not specified	None specified
entities[].derived[].fields[].bbox	null | object	Conditional	Not specified	None specified
entities[].derived[].fields[].bbox.east	string	Conditional	Not specified	None specified
entities[].derived[].fields[].bbox.north	string	Conditional	Not specified	None specified
entities[].derived[].fields[].bbox.south	string	Conditional	Not specified	None specified
entities[].derived[].fields[].bbox.west	string	Conditional	Not specified	None specified
entities[].derived[].fields[].classification	string	Yes	internal public restricted	None specified
entities[].derived[].fields[].id	string	Yes	Not specified	None specified
entities[].derived[].fields[].maxBytes	integer	Conditional	Not specified	format: uint32 minimum: 0
entities[].derived[].fields[].maxLength	integer	Conditional	Not specified	format: uint32 minimum: 0
entities[].derived[].fields[].maximum	null | string	Conditional	Not specified	None specified
entities[].derived[].fields[].minLength	integer	Conditional	Not specifiedSchema default, where declared: 0	format: uint32 minimum: 0
entities[].derived[].fields[].minimum	null | string	Conditional	Not specified	None specified
entities[].derived[].fields[].onDelete	string	Conditional	restrict Schema default, where declared: "restrict"	None specified
entities[].derived[].fields[].precision	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
entities[].derived[].fields[].scale	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
entities[].derived[].fields[].target	string	Conditional	Not specified	None specified
entities[].derived[].fields[].type	string	Yes	boolean crs84-point date decimal int64 reference string structured text timestamp uuid vocabulary-code	None specified
entities[].derived[].fields[].values	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].derived[].fields[].values[]Array item	string	Conditional	Not specified	None specified
entities[].derived[].fields[].vocabulary	string	Conditional	Not specified	None specified
entities[].derived[].id	string	Yes	Not specified	None specified
entities[].derived[].key	string	Yes	Not specified	None specified
entities[].derived[].sql	string	Yes	Not specified	None specified
entities[].events	array	No	Not specifiedSchema default, where declared: []	None specified
entities[].events[]Array item	object	No	Not specified	None specified
entities[].events[].idStable event contract identifier, sent as ce-type. Use a new identifier for a breaking payload change.	string	Yes	Not specified	None specified
entities[].events[].projectionDeclared field identifiers to include in values. System event metadata is included separately.	array	Yes	Not specified	uniqueItems: true
entities[].events[].projection[]Array item	string	No	Not specified	None specified
entities[].events[].triggerCommitted record change that can produce this event.	string	Yes	created patched request_lifecycle tombstoned	None specified
entities[].events[].webhookLogical delivery destination. Production compilation requires a webhook.	null | object	No	Not specified	None specified
entities[].events[].webhook.destinationIdKey in runtime eventDestinations; the project carries no URL or secret.	string	Conditional	Not specified	None specified
entities[].events[].whenOptional field tests, combined with AND. Omit to emit on every matching trigger.	null | object	No	Not specified	None specified
entities[].events[].when.afterEqualsRequired values after the change. Valid with created and patched triggers.	object	Conditional	Not specifiedSchema default, where declared: {}	None specified
entities[].events[].when.afterEquals.*Map valueA comparison literal in the closed field-condition language. Objects and arrays are refused during source parsing. The compiler then validates each scalar against the declared Registry field type.	boolean | null | number | string	Conditional	Not specified	None specified
entities[].events[].when.beforeEqualsRequired values before the change. Valid with patched and tombstoned triggers.	object	Conditional	Not specifiedSchema default, where declared: {}	None specified
entities[].events[].when.beforeEquals.*Map valueA comparison literal in the closed field-condition language. Objects and arrays are refused during source parsing. The compiler then validates each scalar against the declared Registry field type.	boolean | null | number | string	Conditional	Not specified	None specified
entities[].events[].when.changedFields whose values must change. Only valid with the patched trigger.	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].events[].when.changed[]Array item	string	Conditional	Not specified	None specified
entities[].events[].when.kind	string	Conditional	fields request_lifecycle	None specified
entities[].events[].when.stages	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].events[].when.stages[]Array item	string	Conditional	Not specified	None specified
entities[].events[].when.toStates	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].events[].when.toStates[]Array item	string	Conditional	Not specified	None specified
entities[].events[].when.transitions	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
entities[].events[].when.transitions[]Array item	string	Conditional	Not specified	None specified
entities[].fields	array	No	Not specifiedSchema default, where declared: []	None specified
entities[].fields[]Array item	object	No	Not specified	None specified
entities[].fields[].apiName	null | string	No	Not specifiedSchema default, where declared: null	None specified
entities[].fields[].bbox	null | object	Conditional	Not specifiedSchema default, where declared: null	None specified
entities[].fields[].bbox.east	string	Conditional	Not specified	None specified
entities[].fields[].bbox.north	string	Conditional	Not specified	None specified
entities[].fields[].bbox.south	string	Conditional	Not specified	None specified
entities[].fields[].bbox.west	string	Conditional	Not specified	None specified
entities[].fields[].classification	string	Yes	internal public restricted	None specified
entities[].fields[].id	string	Yes	Not specified	None specified
entities[].fields[].maxBytes	integer	Conditional	Not specified	format: uint32 minimum: 0
entities[].fields[].maxLength	integer	Conditional	Not specified	format: uint32 minimum: 0
entities[].fields[].maximum	null | string	Conditional	Not specifiedSchema default, where declared: null	None specified
entities[].fields[].minLength	integer	Conditional	Not specifiedSchema default, where declared: 0	format: uint32 minimum: 0
entities[].fields[].minimum	null | string	Conditional	Not specifiedSchema default, where declared: null	None specified
entities[].fields[].onDelete	string	Conditional	restrict Schema default, where declared: "restrict"	None specified
entities[].fields[].precision	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
entities[].fields[].required	boolean	No	Not specifiedSchema default, where declared: false	None specified
entities[].fields[].scale	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
entities[].fields[].target	string	Conditional	Not specified	None specified
entities[].fields[].type	string	Yes	boolean crs84-point date decimal int64 reference string structured text timestamp uuid vocabulary-code	None specified
entities[].fields[].validTimeRole	null | string	No	valid_from valid_to Schema default, where declared: null	None specified
entities[].fields[].values	array	Conditional	Not specifiedSchema default, where declared: []	None specified
entities[].fields[].values[]Array item	string	Conditional	Not specified	None specified
entities[].fields[].vocabulary	string	Conditional	Not specified	None specified
entities[].geojson	null | object	No	Not specified	None specified
entities[].geojson.geometryField	string	Conditional	Not specified	None specified
entities[].id	string	Yes	Not specified	None specified
entities[].indexes	array	No	Not specifiedSchema default, where declared: []	None specified
entities[].indexes[]Array item	object	No	Not specified	None specified
entities[].indexes[].fields	array	Yes	Not specified	None specified
entities[].indexes[].fields[]Array item	string	No	Not specified	None specified
entities[].indexes[].id	string	Yes	Not specified	None specified
entities[].mutationMode	string	Yes	create_only mutable	None specified
entities[].primaryDataset	string	Yes	Not specified	None specified
entities[].readPaths	array	No	Not specified	None specified
entities[].readPaths[]Array item	object	No	Not specified	None specified
entities[].readPaths[].id	string	Yes	Not specified	None specified
entities[].readPaths[].route	string	Yes	Not specified	None specified
entities[].readPaths[].through	string	Yes	Not specified	None specified
entities[].readPaths[].to	string	Yes	Not specified	None specified
entities[].route	string	Yes	Not specified	None specified
entities[].selectorProfiles	array	No	Not specified	None specified
entities[].selectorProfiles[]Array item	object	No	Not specified	None specified
entities[].selectorProfiles[].fields	array	Yes	Not specified	None specified
entities[].selectorProfiles[].fields[]Array item	string	No	Not specified	None specified
entities[].selectorProfiles[].id	string	Yes	Not specified	None specified
entities[].temporal	null | object	No	Not specifiedSchema default, where declared: null	None specified
entities[].temporal.endField	string	Conditional	Not specified	None specified
entities[].temporal.scopeFieldsDeprecated bounded predecessor bridge. New authoring should declare exclusivity only through constraints[].scopeFields.	array	Conditional	Not specified	None specified
entities[].temporal.scopeFields[]Array item	string	Conditional	Not specified	None specified
entities[].temporal.startField	string	Conditional	Not specified	None specified
entities[].tombstone	boolean	No	Not specifiedSchema default, where declared: false	None specified
extendEntitiesAdditive contributions to entities already declared by the project or another module.	array	No	Not specifiedSchema default, where declared: []	None specified
extendEntities[]Array item	object	No	Not specified	None specified
extendEntities[].accessRequirementsAdd mandatory requirements only when the entity has none; replacing them is refused.	null | object	No	Not specified	None specified
extendEntities[].accessRequirements.allowedPurposesWhen nonempty, every profile must restrict purpose to a nonempty subset of these values. Empty imposes no purpose requirement.	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
extendEntities[].accessRequirements.allowedPurposes[]Array item	string	Conditional	Not specified	None specified
extendEntities[].accessRequirements.requiredScopesEvery profile must require all these scopes. Requirements never grant access.	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
extendEntities[].accessRequirements.requiredScopes[]Array item	string	Conditional	Not specified	None specified
extendEntities[].accessRequirements.rowBoundariesEvery profile must include these exact field, verified-claim, and operator bindings.	array	Conditional	Not specifiedSchema default, where declared: []	None specified
extendEntities[].accessRequirements.rowBoundaries[]Array item	object	Conditional	Not specified	None specified
extendEntities[].accessRequirements.rowBoundaries[].claim	string	Conditional	Not specified	None specified
extendEntities[].accessRequirements.rowBoundaries[].field	string	Conditional	Not specified	None specified
extendEntities[].accessRequirements.rowBoundaries[].operator	string	Conditional	equals in	None specified
extendEntities[].changeControl	null | object	No	Not specified	None specified
extendEntities[].changeControl.requiredFor	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
extendEntities[].changeControl.requiredFor[]Array item	string	Conditional	apply_request approve_request batch cancel_request create get invoke list lookup patch reject_request request_revision revise_request revisions snapshot submit_request tombstone	None specified
extendEntities[].changeRequest	null | object	No	Not specified	None specified
extendEntities[].changeRequest.application	object	Conditional	Not specifiedSchema default, where declared: {"mode":"manual"}	None specified
extendEntities[].changeRequest.application.allowedDispositions	array	Conditional	Not specified	uniqueItems: true
extendEntities[].changeRequest.application.allowedDispositions[]Array item	string	Conditional	apply queue	None specified
extendEntities[].changeRequest.application.mode	string	Conditional	automatic manual planner Schema default, where declared: "manual"	None specified
extendEntities[].changeRequest.application.queueReasons	object	Conditional	Not specified	None specified
extendEntities[].changeRequest.application.queueReasons.*Map value	string	Conditional	Not specified	None specified
extendEntities[].changeRequest.effects	array	Conditional	Not specifiedSchema default, where declared: []	None specified
extendEntities[].changeRequest.effects[]Array item	object	Conditional	Not specified	None specified
extendEntities[].changeRequest.effects[].clear	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
extendEntities[].changeRequest.effects[].clear[]Array item	string	Conditional	Not specified	None specified
extendEntities[].changeRequest.effects[].id	null | string	Conditional	Not specified	None specified
extendEntities[].changeRequest.effects[].operation	string	Conditional	apply_request approve_request batch cancel_request create get invoke list lookup patch reject_request request_revision revise_request revisions snapshot submit_request tombstone	None specified
extendEntities[].changeRequest.effects[].set	object	Conditional	Not specifiedSchema default, where declared: {}	None specified
extendEntities[].changeRequest.effects[].set.*Map value	object	Conditional	Not specified	None specified
extendEntities[].changeRequest.effects[].set.*.fromEffect	null | string	Conditional	Not specified	None specified
extendEntities[].changeRequest.effects[].set.*.fromField	null | string	Conditional	Not specified	None specified
extendEntities[].changeRequest.effects[].target	object	Conditional	Not specified	None specified
extendEntities[].changeRequest.effects[].target.entity	null | string	Conditional	Not specified	None specified
extendEntities[].changeRequest.effects[].target.fromField	null | string	Conditional	Not specified	None specified
extendEntities[].changeRequest.planner	null | object	Conditional	Not specified	None specified
extendEntities[].changeRequest.planner.abi	string	Conditional	Not specified	None specified
extendEntities[].changeRequest.planner.kind	string	Conditional	rhai	None specified
extendEntities[].changeRequest.planner.requestFields	array	Conditional	Not specifiedSchema default, where declared: []	None specified
extendEntities[].changeRequest.planner.requestFields[]Array item	string	Conditional	Not specified	None specified
extendEntities[].changeRequest.planner.script	string	Conditional	Not specified	None specified
extendEntities[].changeRequest.planner.writes	array	Conditional	Not specifiedSchema default, where declared: []	None specified
extendEntities[].changeRequest.planner.writes[]Array item	object	Conditional	Not specified	None specified
extendEntities[].changeRequest.planner.writes[].fields	array	Conditional	Not specifiedSchema default, where declared: []	None specified
extendEntities[].changeRequest.planner.writes[].fields[]Array item	string	Conditional	Not specified	None specified
extendEntities[].changeRequest.planner.writes[].operation	string	Conditional	apply_request approve_request batch cancel_request create get invoke list lookup patch reject_request request_revision revise_request revisions snapshot submit_request tombstone	None specified
extendEntities[].changeRequest.planner.writes[].target	object	Conditional	Not specified	None specified
extendEntities[].changeRequest.planner.writes[].target.entity	null | string	Conditional	Not specified	None specified
extendEntities[].changeRequest.planner.writes[].target.fromField	null | string	Conditional	Not specified	None specified
extendEntities[].changeRequest.retention	object	Conditional	Not specifiedSchema default, where declared: {"mode":"retain"}	None specified
extendEntities[].changeRequest.retention.mode	string	Conditional	operator_erase retain Schema default, where declared: "retain"	None specified
extendEntities[].changeRequest.review	object	Conditional	Not specified	None specified
extendEntities[].changeRequest.review.mode	null | string	Conditional	none	None specified
extendEntities[].changeRequest.review.stages	array	Conditional	Not specifiedSchema default, where declared: []	None specified
extendEntities[].changeRequest.review.stages[]Array item	object	Conditional	Not specified	None specified
extendEntities[].changeRequest.review.stages[].approvals	integer	Conditional	Not specified	format: uint16 maximum: 65535 minimum: 0
extendEntities[].changeRequest.review.stages[].excludePreviousReviewersRefuse an actor who already decided another stage of this proposal version.	boolean	Conditional	Not specifiedSchema default, where declared: false	None specified
extendEntities[].changeRequest.review.stages[].excludeSubmitter	boolean	Conditional	Not specifiedSchema default, where declared: false	None specified
extendEntities[].changeRequest.review.stages[].id	string	Conditional	Not specified	None specified
extendEntities[].constraints	array	No	Not specifiedSchema default, where declared: []	None specified
extendEntities[].constraints[]Array item	object	No	Not specified	None specified
extendEntities[].constraints[].endField	null | string	Conditional	Not specifiedSchema default, where declared: null	None specified
extendEntities[].constraints[].field	string	Conditional	Not specified	None specified
extendEntities[].constraints[].fields	array	Conditional	Not specified	None specified
extendEntities[].constraints[].fields[]Array item	string	Conditional	Not specified	None specified
extendEntities[].constraints[].id	null | string	No	Not specifiedSchema default, where declared: null	None specified
extendEntities[].constraints[].kind	string	Yes	compare int_range temporal-non-overlap unique vocabulary	None specified
extendEntities[].constraints[].left	string	Conditional	Not specified	None specified
extendEntities[].constraints[].maximum	integer | null	Conditional	Not specifiedSchema default, where declared: null	format: int64
extendEntities[].constraints[].minimum	integer | null	Conditional	Not specifiedSchema default, where declared: null	format: int64
extendEntities[].constraints[].operator	string	Conditional	greater_than greater_than_or_equal less_than less_than_or_equal	None specified
extendEntities[].constraints[].right	string	Conditional	Not specified	None specified
extendEntities[].constraints[].scopeFields	array	Conditional	Not specified	None specified
extendEntities[].constraints[].scopeFields[]Array item	string	Conditional	Not specified	None specified
extendEntities[].constraints[].startField	null | string	Conditional	Not specifiedSchema default, where declared: null	None specified
extendEntities[].constraints[].values	array	Conditional	Not specified	None specified
extendEntities[].constraints[].values[]Array item	string	Conditional	Not specified	None specified
extendEntities[].constraints[].when	array | null	Conditional	Not specified	None specified
extendEntities[].constraints[].when[]Array item	object	Conditional	Not specified	None specified
extendEntities[].constraints[].when[].field	string	Conditional	Not specified	None specified
extendEntities[].constraints[].when[].kind	string	Conditional	active_lifecycle field_equals field_is_not_null field_is_null	None specified
extendEntities[].derived	array	No	Not specified	None specified
extendEntities[].derived[]Array item	object	No	Not specified	None specified
extendEntities[].derived[].execution	string	No	live Schema default, where declared: "live"	None specified
extendEntities[].derived[].fields	array	No	Not specifiedSchema default, where declared: []	None specified
extendEntities[].derived[].fields[]Array item	object	No	Not specified	None specified
extendEntities[].derived[].fields[].apiName	null | string	No	Not specified	None specified
extendEntities[].derived[].fields[].bbox	null | object	Conditional	Not specified	None specified
extendEntities[].derived[].fields[].bbox.east	string	Conditional	Not specified	None specified
extendEntities[].derived[].fields[].bbox.north	string	Conditional	Not specified	None specified
extendEntities[].derived[].fields[].bbox.south	string	Conditional	Not specified	None specified
extendEntities[].derived[].fields[].bbox.west	string	Conditional	Not specified	None specified
extendEntities[].derived[].fields[].classification	string	Yes	internal public restricted	None specified
extendEntities[].derived[].fields[].id	string	Yes	Not specified	None specified
extendEntities[].derived[].fields[].maxBytes	integer	Conditional	Not specified	format: uint32 minimum: 0
extendEntities[].derived[].fields[].maxLength	integer	Conditional	Not specified	format: uint32 minimum: 0
extendEntities[].derived[].fields[].maximum	null | string	Conditional	Not specified	None specified
extendEntities[].derived[].fields[].minLength	integer	Conditional	Not specifiedSchema default, where declared: 0	format: uint32 minimum: 0
extendEntities[].derived[].fields[].minimum	null | string	Conditional	Not specified	None specified
extendEntities[].derived[].fields[].onDelete	string	Conditional	restrict Schema default, where declared: "restrict"	None specified
extendEntities[].derived[].fields[].precision	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
extendEntities[].derived[].fields[].scale	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
extendEntities[].derived[].fields[].target	string	Conditional	Not specified	None specified
extendEntities[].derived[].fields[].type	string	Yes	boolean crs84-point date decimal int64 reference string structured text timestamp uuid vocabulary-code	None specified
extendEntities[].derived[].fields[].values	array	Conditional	Not specifiedSchema default, where declared: []	None specified
extendEntities[].derived[].fields[].values[]Array item	string	Conditional	Not specified	None specified
extendEntities[].derived[].fields[].vocabulary	string	Conditional	Not specified	None specified
extendEntities[].derived[].id	string	Yes	Not specified	None specified
extendEntities[].derived[].key	string	Yes	Not specified	None specified
extendEntities[].derived[].sql	string	Yes	Not specified	None specified
extendEntities[].entity	string	Yes	Not specified	None specified
extendEntities[].events	array	No	Not specifiedSchema default, where declared: []	None specified
extendEntities[].events[]Array item	object	No	Not specified	None specified
extendEntities[].events[].idStable event contract identifier, sent as ce-type. Use a new identifier for a breaking payload change.	string	Yes	Not specified	None specified
extendEntities[].events[].projectionDeclared field identifiers to include in values. System event metadata is included separately.	array	Yes	Not specified	uniqueItems: true
extendEntities[].events[].projection[]Array item	string	No	Not specified	None specified
extendEntities[].events[].triggerCommitted record change that can produce this event.	string	Yes	created patched request_lifecycle tombstoned	None specified
extendEntities[].events[].webhookLogical delivery destination. Production compilation requires a webhook.	null | object	No	Not specified	None specified
extendEntities[].events[].webhook.destinationIdKey in runtime eventDestinations; the project carries no URL or secret.	string	Conditional	Not specified	None specified
extendEntities[].events[].whenOptional field tests, combined with AND. Omit to emit on every matching trigger.	null | object	No	Not specified	None specified
extendEntities[].events[].when.afterEqualsRequired values after the change. Valid with created and patched triggers.	object	Conditional	Not specifiedSchema default, where declared: {}	None specified
extendEntities[].events[].when.afterEquals.*Map valueA comparison literal in the closed field-condition language. Objects and arrays are refused during source parsing. The compiler then validates each scalar against the declared Registry field type.	boolean | null | number | string	Conditional	Not specified	None specified
extendEntities[].events[].when.beforeEqualsRequired values before the change. Valid with patched and tombstoned triggers.	object	Conditional	Not specifiedSchema default, where declared: {}	None specified
extendEntities[].events[].when.beforeEquals.*Map valueA comparison literal in the closed field-condition language. Objects and arrays are refused during source parsing. The compiler then validates each scalar against the declared Registry field type.	boolean | null | number | string	Conditional	Not specified	None specified
extendEntities[].events[].when.changedFields whose values must change. Only valid with the patched trigger.	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
extendEntities[].events[].when.changed[]Array item	string	Conditional	Not specified	None specified
extendEntities[].events[].when.kind	string	Conditional	fields request_lifecycle	None specified
extendEntities[].events[].when.stages	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
extendEntities[].events[].when.stages[]Array item	string	Conditional	Not specified	None specified
extendEntities[].events[].when.toStates	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
extendEntities[].events[].when.toStates[]Array item	string	Conditional	Not specified	None specified
extendEntities[].events[].when.transitions	array	Conditional	Not specifiedSchema default, where declared: []	uniqueItems: true
extendEntities[].events[].when.transitions[]Array item	string	Conditional	Not specified	None specified
extendEntities[].fields	array	No	Not specifiedSchema default, where declared: []	None specified
extendEntities[].fields[]Array item	object	No	Not specified	None specified
extendEntities[].fields[].apiName	null | string	No	Not specifiedSchema default, where declared: null	None specified
extendEntities[].fields[].bbox	null | object	Conditional	Not specifiedSchema default, where declared: null	None specified
extendEntities[].fields[].bbox.east	string	Conditional	Not specified	None specified
extendEntities[].fields[].bbox.north	string	Conditional	Not specified	None specified
extendEntities[].fields[].bbox.south	string	Conditional	Not specified	None specified
extendEntities[].fields[].bbox.west	string	Conditional	Not specified	None specified
extendEntities[].fields[].classification	string	Yes	internal public restricted	None specified
extendEntities[].fields[].id	string	Yes	Not specified	None specified
extendEntities[].fields[].maxBytes	integer	Conditional	Not specified	format: uint32 minimum: 0
extendEntities[].fields[].maxLength	integer	Conditional	Not specified	format: uint32 minimum: 0
extendEntities[].fields[].maximum	null | string	Conditional	Not specifiedSchema default, where declared: null	None specified
extendEntities[].fields[].minLength	integer	Conditional	Not specifiedSchema default, where declared: 0	format: uint32 minimum: 0
extendEntities[].fields[].minimum	null | string	Conditional	Not specifiedSchema default, where declared: null	None specified
extendEntities[].fields[].onDelete	string	Conditional	restrict Schema default, where declared: "restrict"	None specified
extendEntities[].fields[].precision	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
extendEntities[].fields[].required	boolean	No	Not specifiedSchema default, where declared: false	None specified
extendEntities[].fields[].scale	integer	Conditional	Not specified	format: uint8 maximum: 255 minimum: 0
extendEntities[].fields[].target	string	Conditional	Not specified	None specified
extendEntities[].fields[].type	string	Yes	boolean crs84-point date decimal int64 reference string structured text timestamp uuid vocabulary-code	None specified
extendEntities[].fields[].validTimeRole	null | string	No	valid_from valid_to Schema default, where declared: null	None specified
extendEntities[].fields[].values	array	Conditional	Not specifiedSchema default, where declared: []	None specified
extendEntities[].fields[].values[]Array item	string	Conditional	Not specified	None specified
extendEntities[].fields[].vocabulary	string	Conditional	Not specified	None specified
extendEntities[].geojson	null | object	No	Not specified	None specified
extendEntities[].geojson.geometryField	string	Conditional	Not specified	None specified
extendEntities[].indexes	array	No	Not specifiedSchema default, where declared: []	None specified
extendEntities[].indexes[]Array item	object	No	Not specified	None specified
extendEntities[].indexes[].fields	array	Yes	Not specified	None specified
extendEntities[].indexes[].fields[]Array item	string	No	Not specified	None specified
extendEntities[].indexes[].id	string	Yes	Not specified	None specified
extendEntities[].readPaths	array	No	Not specified	None specified
extendEntities[].readPaths[]Array item	object	No	Not specified	None specified
extendEntities[].readPaths[].id	string	Yes	Not specified	None specified
extendEntities[].readPaths[].route	string	Yes	Not specified	None specified
extendEntities[].readPaths[].through	string	Yes	Not specified	None specified
extendEntities[].readPaths[].to	string	Yes	Not specified	None specified
extendEntities[].selectorProfiles	array	No	Not specified	None specified
extendEntities[].selectorProfiles[]Array item	object	No	Not specified	None specified
extendEntities[].selectorProfiles[].fields	array	Yes	Not specified	None specified
extendEntities[].selectorProfiles[].fields[]Array item	string	No	Not specified	None specified
extendEntities[].selectorProfiles[].id	string	Yes	Not specified	None specified
idStable module identifier, referenced by the project's module lock.	string	Yes	Not specified	None specified
versionModule version recorded alongside its content digest in the project.	string	Yes	Not specified	None specified

runtime.yaml

Source preview, pre-1.0

Generated from products/breg/generated/runtime/runtime.schema.json. 89 key paths. Explained in docs/site/src/content/docs/configure/breg.mdx.

Key path	Type	Required	Accepted values	Constraints
apiVersion	string	Yes	registry.registrystack.org/breg-runtime/v1alpha1	None specified
audit	object	Yes	Not specified	None specified
audit.hashKeyRef	string	Yes	Not specified	maxLength: 140 minLength: 1 pattern: ^(secret:env/[A-Z][A-Z0-9_]{0,127}|secret:file/[a-z][a-z0-9._-]{0,127})$
authentication	object	Yes	Not specified	None specified
authentication.authorityClaims	object	Yes	Not specified	None specified
authentication.authorityClaims.principal	string	Yes	Not specified	maxLength: 128 minLength: 1 pattern: ^[\x21-\x7E]+$
authentication.authorityClaims.purpose	null | string	No	Not specified	maxLength: 128 minLength: 1 pattern: ^[\x21-\x7E]+$
authentication.oidc	object	Yes	Not specified	None specified
authentication.oidc.accessTokenType	string	Yes	Not specified	maxLength: 2048 minLength: 1 pattern: ^[^\s\x00-\x1F\x7F](?:[^\x00-\x1F\x7F]*[^\s\x00-\x1F\x7F])?$
authentication.oidc.allowedAlgorithm	string	Yes	ES256 ES384 EdDSA RS256 RS384	None specified
authentication.oidc.allowedClients	array	No	Not specified	maxItems: 128 uniqueItems: true
authentication.oidc.allowedClients[]Array item	string	No	Not specified	maxLength: 512 minLength: 1 pattern: ^[^\x00-\x20\x7F]+$
authentication.oidc.audience	string	Yes	Not specified	maxLength: 2048 minLength: 1 pattern: ^[^\s\x00-\x1F\x7F](?:[^\x00-\x1F\x7F]*[^\s\x00-\x1F\x7F])?$
authentication.oidc.deniedKids	array	No	Not specified	maxItems: 128 uniqueItems: true
authentication.oidc.deniedKids[]Array item	string	No	Not specified	maxLength: 512 minLength: 1 pattern: ^[^\x00-\x20\x7F]+$
authentication.oidc.issuer	string	Yes	Not specified	maxLength: 2048 minLength: 1 pattern: ^[^\s\x00-\x1F\x7F](?:[^\x00-\x1F\x7F]*[^\s\x00-\x1F\x7F])?$
authentication.oidc.jwksCacheOptional JWKS fetch and cache tuning. Defaults to bounded cache behavior.	object	No	Not specifiedSchema default, where declared: {"cacheTtlSeconds":600,"maxDocumentBytes":65536,"negativeCacheTtlSeconds":60,"outageToleranceSeconds":900,"refreshCooldownSeconds":30,"requestTimeoutMilliseconds":5000}	None specified
authentication.oidc.jwksCache.cacheTtlSecondsDefaults to the bounded JWKS cache time-to-live.	integer	No	Not specifiedSchema default, where declared: 600	format: uint64 maximum: 86400 minimum: 1
authentication.oidc.jwksCache.maxDocumentBytesDefaults to the bounded maximum JWKS document size.	integer	No	Not specifiedSchema default, where declared: 65536	format: uint64 maximum: 1048576 minimum: 1
authentication.oidc.jwksCache.negativeCacheTtlSecondsDefaults to the bounded JWKS negative-cache time-to-live.	integer	No	Not specifiedSchema default, where declared: 60	format: uint64 maximum: 3600 minimum: 1
authentication.oidc.jwksCache.outageToleranceSecondsDefaults to the bounded cached-key outage tolerance.	integer	No	Not specifiedSchema default, where declared: 900	format: uint64 maximum: 86400 minimum: 0
authentication.oidc.jwksCache.refreshCooldownSecondsDefaults to the bounded JWKS refresh cooldown.	integer	No	Not specifiedSchema default, where declared: 30	format: uint64 maximum: 3600 minimum: 1
authentication.oidc.jwksCache.requestTimeoutMillisecondsDefaults to the bounded JWKS fetch timeout.	integer	No	Not specifiedSchema default, where declared: 5000	format: uint64 maximum: 30000 minimum: 1
authentication.oidc.jwksSource	null | object	No	Not specified	None specified
authentication.oidc.jwksSource.documentRef	string	Conditional	Not specified	maxLength: 140 minLength: 1 pattern: ^(secret:env/[A-Z][A-Z0-9_]{0,127}|secret:file/[a-z][a-z0-9._-]{0,127})$
authentication.oidc.jwksSource.kind	string	Conditional	discovery static	None specified
authentication.oidc.leewayMilliseconds	integer	Yes	Not specified	format: uint64 maximum: 300000 minimum: 0
authentication.oidc.maxTokenLifetimeSeconds	integer	Yes	Not specified	format: uint64 maximum: 7200 minimum: 1
authentication.oidc.scopeClaim	string	Yes	Not specified	maxLength: 128 minLength: 1 pattern: ^[\x21-\x7E]+$
authentication.oidc.scopeSeparator	string	Yes	Not specified	maxLength: 1 minLength: 1 pattern: ^[^A-Za-z0-9\x00-\x1F\x7F]$
cursor	object	Yes	Not specified	None specified
cursor.maxAgeSecondsDefaults to the bounded cursor validity lifetime.	integer	No	Not specifiedSchema default, where declared: 300	format: uint64 maximum: 86400 minimum: 1
cursor.secretRef	string	Yes	Not specified	maxLength: 140 minLength: 1 pattern: ^(secret:env/[A-Z][A-Z0-9_]{0,127}|secret:file/[a-z][a-z0-9._-]{0,127})$
database	object	Yes	Not specified	None specified
database.migrationUrlRef	string	Yes	Not specified	maxLength: 140 minLength: 1 pattern: ^(secret:env/[A-Z][A-Z0-9_]{0,127}|secret:file/[a-z][a-z0-9._-]{0,127})$
database.pool	object	Yes	Not specified	None specified
database.pool.createTimeoutMillisecondsDefaults to the bounded PostgreSQL pool connection-creation timeout.	integer	No	Not specifiedSchema default, where declared: 30000	format: uint64 maximum: 60000 minimum: 1
database.pool.maxSize	integer	Yes	Not specified	format: uint maximum: 128 minimum: 1
database.pool.recycleTimeoutMillisecondsDefaults to the bounded PostgreSQL pool connection-recycle timeout.	integer	No	Not specifiedSchema default, where declared: 30000	format: uint64 maximum: 60000 minimum: 1
database.pool.waitTimeoutMillisecondsDefaults to the bounded PostgreSQL pool wait timeout.	integer	No	Not specifiedSchema default, where declared: 30000	format: uint64 maximum: 60000 minimum: 1
database.roles	object	Yes	Not specified	None specified
database.roles.migration	string	Yes	Not specified	maxLength: 63 minLength: 1 pattern: ^[_a-z][_a-z0-9]{0,62}$
database.roles.runtime	string	Yes	Not specified	maxLength: 63 minLength: 1 pattern: ^[_a-z][_a-z0-9]{0,62}$
database.runtimeUrlRef	string	Yes	Not specified	maxLength: 140 minLength: 1 pattern: ^(secret:env/[A-Z][A-Z0-9_]{0,127}|secret:file/[a-z][a-z0-9._-]{0,127})$
eventDeliveryOptional event-delivery tuning. Defaults to the server's bounded retention policy.	object	No	Not specifiedSchema default, where declared: {"payloadRetentionDays":7}	None specified
eventDelivery.payloadRetentionDaysDefaults to the bounded retained payload lifetime for pending or dead-letter webhook work.	integer	No	Not specifiedSchema default, where declared: 7	format: uint8 maximum: 30 minimum: 1
eventDestinations	object	No	Not specified	maxProperties: 128
eventDestinations.*Map value	object	No	Not specifiedSchema default, where declared:	propertyNames.pattern: ^[a-z][a-z0-9_-]{0,63}$
eventDestinations.*.allowedPrivateCidrsExplicitly allowed private network ranges in canonical CIDR notation.	array	Yes	Not specified	maxItems: 16 uniqueItems: true
eventDestinations.*.allowedPrivateCidrs[]Array item	string	No	Not specified	None specified
eventDestinations.*.classificationCeilingHighest permitted classification, including fields used only in event conditions.	string	Yes	internal public restricted	None specified
eventDestinations.*.deliveryCeilingsPer-destination limits that may tighten, but never increase, the compiled delivery limits.	object	Yes	Not specified	None specified
eventDestinations.*.deliveryCeilings.attemptTimeoutMillisecondsMaximum time allowed for one attempt, in milliseconds.	integer	Yes	Not specified	format: uint32 maximum: 5000 minimum: 100
eventDestinations.*.deliveryCeilings.maximumAttemptsMaximum total attempts in one delivery generation, including the first attempt.	integer	Yes	Not specified	format: uint8 maximum: 5 minimum: 1
eventDestinations.*.dnsFamilyAddress families to validate when resolving the destination.	string	Yes	dualStackStrict ipv4Only	None specified
eventDestinations.*.hmacSha256KeyRefRuntime secret reference for the receiver's shared HMAC-SHA-256 key.	string	Yes	Not specified	maxLength: 140 minLength: 1 pattern: ^(secret:env/[A-Z][A-Z0-9_]{0,127}|secret:file/[a-z][a-z0-9._-]{0,127})$
eventDestinations.*.networkProfileHTTPS for production, or explicit loopback-only HTTP for local development.	string	Yes	loopbackDevelopmentHttp productionHttps	None specified
eventDestinations.*.originReceiver origin without a path or query, such as https://receiver.example.com.	string	Yes	Not specified	maxLength: 2048 minLength: 1
eventDestinations.*.pathAbsolute request path on the configured origin, such as /events.	string	Yes	Not specified	maxLength: 4096 minLength: 1 pattern: ^/[\x20-\x22\x24\x26-\x3E\x40-\x5B\x5D-\x7E]*$
eventDestinations.*.tlsOptional private CA and client identity secret references for HTTPS.	null | object	No	Not specified	None specified
eventDestinations.*.tls.caBundleRefPEM CA bundle secret reference, when the receiver uses a private certificate authority.	null | string	Conditional	Not specified	maxLength: 140 minLength: 1 pattern: ^(secret:env/[A-Z][A-Z0-9_]{0,127}|secret:file/[a-z][a-z0-9._-]{0,127})$
eventDestinations.*.tls.clientIdentityRefPEM client identity secret reference for mutual TLS.	null | string	Conditional	Not specified	maxLength: 140 minLength: 1 pattern: ^(secret:env/[A-Z][A-Z0-9_]{0,127}|secret:file/[a-z][a-z0-9._-]{0,127})$
identity	object	Yes	Not specified	None specified
identity.databaseId	string	Yes	Not specified	maxLength: 256 minLength: 1 pattern: ^[^\s\x00-\x1F\x7F](?:[^\x00-\x1F\x7F]*[^\s\x00-\x1F\x7F])?$
identity.databaseInitializationEnvironment	string	Yes	Not specified	maxLength: 256 minLength: 1 pattern: ^[^\s\x00-\x1F\x7F](?:[^\x00-\x1F\x7F]*[^\s\x00-\x1F\x7F])?$
identity.environment	string	Yes	Not specified	maxLength: 256 minLength: 1 pattern: ^[^\s\x00-\x1F\x7F](?:[^\x00-\x1F\x7F]*[^\s\x00-\x1F\x7F])?$
identity.instanceId	string	Yes	Not specified	maxLength: 256 minLength: 1 pattern: ^[^\s\x00-\x1F\x7F](?:[^\x00-\x1F\x7F]*[^\s\x00-\x1F\x7F])?$
kind	string	Yes	BRegRuntimeConfig	None specified
listener	object	Yes	Not specified	None specified
listener.bind	string	Yes	Not specified	None specified
listener.publicOriginCanonical HTTPS origin (loopback HTTP for local development) for QGIS discovery and pagination. Required when the registry exposes GIS collections.	null | string	No	Not specified	maxLength: 2048 minLength: 1 pattern: ^https?://[^/@?#\s]+/?$
metricsListenerOptional operator-private metrics listener. Absent by default, which serves no metrics surface at all.	null | object	No	Not specifiedSchema default, where declared: null	None specified
metricsListener.bindOperator-private loopback or private numeric address and named port, for example 127.0.0.1:9100.	string	Conditional	Not specified	None specified
operationalTimeoutsOptional operational request, shutdown, locking, and migration timeout tuning.	object	No	Not specifiedSchema default, where declared: {"httpRequestMilliseconds":10000,"migrationLockMilliseconds":30000,"migrationStatementMilliseconds":60000,"recordLockMilliseconds":5000,"shutdownGraceMilliseconds":30000}	None specified
operationalTimeouts.httpRequestMillisecondsDefaults to the bounded per-request HTTP timeout.	integer	No	Not specifiedSchema default, where declared: 10000	format: uint64 maximum: 60000 minimum: 1
operationalTimeouts.migrationLockMillisecondsDefaults to the bounded migration lock timeout.	integer	No	Not specifiedSchema default, where declared: 30000	format: uint64 maximum: 300000 minimum: 1
operationalTimeouts.migrationStatementMillisecondsDefaults to the bounded migration statement timeout.	integer	No	Not specifiedSchema default, where declared: 60000	format: uint64 maximum: 3600000 minimum: 1
operationalTimeouts.recordLockMillisecondsDefaults to the bounded record lock timeout.	integer	No	Not specifiedSchema default, where declared: 5000	format: uint64 maximum: 30000 minimum: 1
operationalTimeouts.shutdownGraceMillisecondsDefaults to the bounded graceful-shutdown timeout.	integer	No	Not specifiedSchema default, where declared: 30000	format: uint64 maximum: 300000 minimum: 1
package	object	Yes	Not specified	None specified
package.activeRevision	string	Yes	Not specified	maxLength: 256 minLength: 1 pattern: ^[^\s\x00-\x1F\x7F](?:[^\x00-\x1F\x7F]*[^\s\x00-\x1F\x7F])?$
package.activeSequence	integer	Yes	Not specified	format: uint64 minimum: 1
package.compilerSourceRevision	string	Yes	Not specified	maxLength: 256 minLength: 1 pattern: ^[^\s\x00-\x1F\x7F](?:[^\x00-\x1F\x7F]*[^\s\x00-\x1F\x7F])?$
package.root	string	Yes	Not specified	maxLength: 512 minLength: 1
package.trustAnchorPath	string	Yes	Not specified	maxLength: 512 minLength: 1
secretProviders	object	Yes	Not specified	None specified
secretProviders.environment	null | object	No	Not specified	None specified
secretProviders.file	null | object	No	Not specified	None specified
secretProviders.file.root	string	Conditional	Not specified	maxLength: 512 minLength: 1

Next

• Author a registry project for models, permissions, and webhooks.
• Events and webhooks for payloads, signatures, retries, and replay.
• Create and query your first registry to try the API.
• How a configured registry works for the product boundaries.