Documentation preview. These pages target Registryctl v0.15.0, which is not published yet. Public download commands will not work until that release exists. For runnable released instructions, use v0.13.0.
This generated reference documents every reachable path in seven Registry Stack configuration
schemas: the five project-authoring schemas plus the Relay and Notary runtime schemas.
Use the purpose, reviewed intent profile, and ownership metadata to choose a field.
Then use registryctl check for a complete project or the product configuration checks for Relay
and Notary runtime configuration.
Contract status
Section titled “Contract status”- Status: current, experimental
- Reference format:
1.0 - Generated by: Main source (unreleased)
- Published release containing this generator: none
- Field release history: not verified
- Compared releases: none
- Generator:
registryctl authoring reference - Coverage gate:
registryctl authoring reference --coverage - Country workspace or runtime configuration reads: none
The generated reference is next-release candidate evidence from current source.
Its field entries use history_status: not_verified, introduced_in: null, and an empty
version_history.
Per-field release history is not published until a release-schema comparison establishes the
versions.
The generator joins the five committed project-authoring JSON Schemas, the Relay and Notary schemas produced directly by their Rust schema APIs, the typed field-knowledge index, and reviewed product-owned human-intent metadata. JSON Schema and Rust validation remain the configuration authority. The reference does not inspect a project, live runtime configuration, environment variables, secret stores, or country values.
The five project-authoring sections describe configuration people commit in a country project.
The Relay and Notary sections describe product-owned runtime contracts generated by registryctl;
they are not additional country-authored files. Their intent sidecars are documentation knowledge
only and are never loaded by either product at runtime.
Download themachine-readable configuration referenceor itsmachine-readable coverage report.
- Configuration schemas
- 7
- Documented paths
- 1771
- Reviewed intent assignments
- 1771 of 1771
- Distinct reviewed intents
- 596
- Reused reviewed intents
- 82 texts across 1257 assignments
- Country workspace reads
- None
Project, environment, integration, fixture, and entity sections describe human-authored country files. Relay and Notary sections describe generated product runtime contracts. The reviewed intent sidecars are documentation knowledge only and are not runtime configuration.
Assignment coverage means that every documented path resolves to reviewed intent. It does not mean that every path has unique prose. Reviewed profiles and structural taxonomy intentionally reuse intent text across paths with the same operational meaning.
Project configuration
Configuration surface: registry-stack.yaml. This section contains 220 documented schema paths.
(document root)Declares the product-neutral Registry Stack project graph: integrations, materialized entities, and Relay or Notary services.
- Path kind
- root
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/access/properties/scopesLists the scopes a caller must hold to use the enclosing evidence service.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/access/properties/scopes/itemsNon-empty token without commas, whitespace, or control characters.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token
/$defs/claimValue/properties/max_bytesBounds the encoded size of a source-free claim value.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/claimValue/properties/nullableStates whether the source-free claim value may be null.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/claimValue/properties/typeDeclares the boolean, integer, string, or date type of a source-free claim value.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/consultations/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/consultations/additionalProperties/properties/inputMaps integration input names to reviewed target-request identifier or attribute bindings.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/consultations/additionalProperties/properties/input/additionalPropertiesClosed target request binding. Attribute values are bounded typed caller-supplied context, not authenticated identifiers.
- Path kind
- map value
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/targetRequestMapping
/$defs/consultations/additionalProperties/properties/input/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/consultations/additionalProperties/properties/integrationLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/consultations/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/disclosure/oneOf/0Maximum detail a claim may disclose.
- Path kind
- branch
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- reference to #/$defs/disclosureMode
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/disclosureMode
/$defs/disclosure/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/disclosure/oneOf/1/properties/allowedLists the disclosure modes that may be selected in addition to the policy's declared default.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/disclosure/oneOf/1/properties/allowed/itemsMaximum detail a claim may disclose.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- reference to #/$defs/disclosureMode
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/disclosureMode
/$defs/disclosure/oneOf/1/properties/defaultMaximum detail a claim may disclose.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- reference to #/$defs/disclosureMode
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/disclosureMode
/$defs/evidenceService/properties/accessScopes a caller must hold to use an evidence service.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/access
/$defs/evidenceService/properties/claimsMaps evidence claim identifiers to an output or CEL expression, value contract, and disclosure policy.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/evidenceService/properties/claims/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/evidenceService/properties/claims/additionalProperties/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/evidenceService/properties/claims/additionalProperties/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/evidenceService/properties/claims/additionalProperties/properties/celProvides the CEL expression used for a source-free evaluation-only evidence claim.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/evidenceService/properties/claims/additionalProperties/properties/disclosureFixed disclosure mode or a default constrained by explicitly allowed alternatives.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/disclosure
/$defs/evidenceService/properties/claims/additionalProperties/properties/outputSelects the exact Relay consultation output that backs this evidence claim.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/evidenceService/properties/claims/additionalProperties/properties/valueExplicit claim value type, nullability, and encoded-size bound for source-free evaluation. A source-free claim cannot be selected by a credential profile.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/claimValue
/$defs/evidenceService/properties/claims/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/evidenceService/properties/consentStates whether evaluation of this evidence service requires consent.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/evidenceService/properties/consultationsRelay consultations and their closed bindings to target request identifiers or caller-supplied target attributes.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/consultations
/$defs/evidenceService/properties/credential_profilesCredential profiles may select only claims backed by an exact Relay consultation. Source-free claim evaluation cannot be exposed as credential capability.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/evidenceService/properties/credential_profiles/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/evidenceService/properties/credential_profiles/additionalProperties/properties/claimsLists the registry-backed evidence claims selected into this credential profile.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/evidenceService/properties/credential_profiles/additionalProperties/properties/claims/itemsLowercase stable identifier used in project references.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/evidenceService/properties/credential_profiles/additionalProperties/properties/formatNon-empty token without commas, whitespace, or control characters.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token
/$defs/evidenceService/properties/credential_profiles/additionalProperties/properties/typeDeclares the credential type identifier emitted for this reviewed credential profile.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/evidenceService/properties/credential_profiles/additionalProperties/properties/validityBounds the lifetime of credentials issued from this profile using a positive duration.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/evidenceService/properties/credential_profiles/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/evidenceService/properties/kindIdentifies this service declaration as a Notary evidence policy.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/evidenceService/properties/legal_basisNon-empty token without commas, whitespace, or control characters.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token
/$defs/evidenceService/properties/purposeNon-empty token without commas, whitespace, or control characters.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token
/$defs/evidenceService/properties/subject_typeSubject category evaluated by this evidence service. Omission is normalized to person.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/evidenceService/properties/variablesTyped request variables exposed to evidence evaluation.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/variables
/$defs/evidenceService/properties/versionAssigns the positive authored version used to track this evidence-service policy contract.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/fieldList/itemsLowercase stable identifier used in project references.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/filterOperators/itemsDefines the contract shared by each ordered item in the enclosing authored list.
- Path kind
- array item
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAggregate/anyOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAggregate/anyOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAggregate/properties/accessDefines optional metadata and aggregate scopes and whether execution is restricted to aggregate-only access.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordAggregateAccess
/$defs/recordAggregate/properties/allowed_filtersMaps aggregate filter fields to the comparison operators permitted for each field.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAggregate/properties/allowed_filters/additionalPropertiesAllowed operators for one queryable field.
- Path kind
- map value
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/filterOperators
/$defs/recordAggregate/properties/default_group_byBounded unique list of entity field identifiers.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/fieldList
/$defs/recordAggregate/properties/descriptionBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordAggregate/properties/dimensionsLists the labeled entity fields available as governed aggregate dimensions.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAggregate/properties/dimensions/itemsNamed grouping dimension backed by one entity field.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordAggregateDimension
/$defs/recordAggregate/properties/disclosure_controlDefines the minimum group size and suppression behavior applied before aggregate results are disclosed.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAggregate/properties/disclosure_control/properties/min_group_sizeSets the smallest result group that may be disclosed without suppression.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAggregate/properties/disclosure_control/properties/suppressionSelects whether undersized aggregate groups are omitted, masked, or represented as null.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAggregate/properties/group_byBounded unique list of entity field identifiers.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/fieldList
/$defs/recordAggregate/properties/indicatorsLists the named aggregate indicators, functions, source columns, and measurement metadata.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAggregate/properties/indicators/itemsSDMX-style aggregate indicator with units and display metadata.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordAggregateIndicator
/$defs/recordAggregate/properties/joinsBounded unique list of entity field identifiers.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/fieldList
/$defs/recordAggregate/properties/measuresLists the named aggregation functions and entity columns used to compute this aggregate.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAggregate/properties/measures/itemsNamed aggregate calculation over one entity column.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordAggregateMeasure
/$defs/recordAggregate/properties/required_principal_filtersBounded unique list of entity field identifiers.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/fieldList
/$defs/recordAggregate/properties/spatialDefines the reviewed administrative-area spatial aggregation and geometry materialization bindings.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordAggregateSpatial
/$defs/recordAggregate/properties/temporal_fieldLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordAggregate/properties/titleBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordAggregateAccess/properties/aggregate_only_executionRestricts this definition to aggregate execution so it cannot be used as a record-level result path.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAggregateAccess/properties/aggregate_scopeAuthorization scope token.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/scope
/$defs/recordAggregateAccess/properties/metadata_scopeAuthorization scope token.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/scope
/$defs/recordAggregateDimension/properties/codelistBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordAggregateDimension/properties/fieldLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordAggregateDimension/properties/idLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordAggregateDimension/properties/labelBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordAggregateIndicator/properties/columnLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordAggregateIndicator/properties/decimalsSets the non-negative decimal precision published for this aggregate indicator.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAggregateIndicator/properties/definition_uriBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordAggregateIndicator/properties/frequencyBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordAggregateIndicator/properties/functionSelects the aggregation function used to compute this named indicator.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- reference to #/$defs/recordAggregateFunction
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordAggregateFunction
/$defs/recordAggregateIndicator/properties/idLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordAggregateIndicator/properties/labelBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordAggregateIndicator/properties/unit_measureBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordAggregateIndicator/properties/unit_multDeclares the base-ten unit multiplier published with this aggregate indicator.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAggregateMeasure/properties/columnLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordAggregateMeasure/properties/functionSelects the aggregation function applied to the optional source column for this measure.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- reference to #/$defs/recordAggregateFunction
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordAggregateFunction
/$defs/recordAggregateMeasure/properties/nameLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordAggregateSpatial/properties/bbox_fieldsMaps the geometry entity fields that provide the minimum and maximum coordinates of its bounding box.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordSpatialBbox
/$defs/recordAggregateSpatial/properties/collection_idLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordAggregateSpatial/properties/dimensionLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordAggregateSpatial/properties/geometry_entityLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordAggregateSpatial/properties/geometry_fieldLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordAggregateSpatial/properties/geometry_id_fieldLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordAggregateSpatial/properties/max_geometry_verticesCaps the number of vertices accepted when materializing one administrative-area geometry.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAggregateSpatial/properties/modeSelects the supported administrative-area aggregation mode for this spatial definition.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAttributeReleaseExpression/properties/celProvides the bounded CEL expression evaluated only against the projected source object.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAttributeReleaseProfile/properties/claimsMaps released claim names to their reviewed source or expression, requiredness, and sensitivity.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAttributeReleaseProfile/properties/claims/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAttributeReleaseProfile/properties/claims/additionalProperties/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAttributeReleaseProfile/properties/claims/additionalProperties/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAttributeReleaseProfile/properties/claims/additionalProperties/properties/expressionBounded CEL evaluated only against the projected source object.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordAttributeReleaseExpression
/$defs/recordAttributeReleaseProfile/properties/claims/additionalProperties/properties/requiredStates whether failure to produce this released claim makes the attribute-release result invalid.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- boolean
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAttributeReleaseProfile/properties/claims/additionalProperties/properties/sensitivityClassifies the released claim as a direct identifier, personal, public, or pseudonymous value.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAttributeReleaseProfile/properties/claims/additionalProperties/properties/source_fieldLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordAttributeReleaseProfile/properties/claims/propertyNamesNames one author-controlled entry in the enclosing typed map; the key is data, not an extension field.
- Path kind
- map key
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAttributeReleaseProfile/properties/descriptionBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordAttributeReleaseProfile/properties/purposeBinds the release to one permitted records purpose and requires a bounded visible-ASCII header token.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token
/$defs/recordAttributeReleaseProfile/properties/release_conditionsContains the bounded expression that must authorize this purpose-bound attribute release.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAttributeReleaseProfile/properties/release_conditions/properties/expressionBounded CEL evaluated only against the projected source object.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordAttributeReleaseExpression
/$defs/recordAttributeReleaseProfile/properties/release_scopeRequires the exact entity-bound <entity_id>:identity_release scope and keeps release access distinct from records API scopes.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/scope
/$defs/recordAttributeReleaseProfile/properties/subjectDefines the projected source field and identifier type used for exact-one subject resolution.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAttributeReleaseProfile/properties/subject/properties/id_typeLabels the identifier type represented by the resolved subject identifier.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAttributeReleaseProfile/properties/subject/properties/source_fieldSelects the projected entity field whose value is matched for exact-one subject resolution.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordAttributeReleaseProfile/properties/titleBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordAttributeReleaseProfile/properties/versionAssigns a portable path-segment version matching [A-Za-z0-9][A-Za-z0-9._-]{0,63} to identify one attribute-release profile contract.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordAttributeReleaseProfiles/additionalPropertiesOne purpose-bound, minimized identity release compiled into the owning Relay entity.
- Path kind
- map value
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordAttributeReleaseProfile
/$defs/recordAttributeReleaseProfiles/propertyNamesNames one author-controlled entry in the enclosing typed map; the key is data, not an extension field.
- Path kind
- map key
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordFieldMap/additionalPropertiesLowercase stable identifier used in project references.
- Path kind
- map value
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordFieldMap/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordSpatial/properties/bbox_fieldsMaps optional entity fields containing precomputed minimum and maximum bounding-box coordinates.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordSpatialBbox
/$defs/recordSpatial/properties/collection_idLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordSpatial/properties/datetime_fieldLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordSpatial/properties/descriptionBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordSpatial/properties/geometryDefines whether feature geometry comes from point-coordinate fields or one encoded geometry field.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordSpatialGeometry
/$defs/recordSpatial/properties/max_bbox_degreesCaps the geographic span accepted for one bounding-box query.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- number
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordSpatial/properties/max_geometry_verticesCaps the number of vertices accepted when returning one feature geometry.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordSpatial/properties/titleBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordSpatialBbox/properties/max_xLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordSpatialBbox/properties/max_yLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordSpatialBbox/properties/min_xLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordSpatialBbox/properties/min_yLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordSpatialGeometry/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordSpatialGeometry/oneOf/0/properties/crsNon-empty token without commas, whitespace, or control characters.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token
/$defs/recordSpatialGeometry/oneOf/0/properties/kindSelects geometry assembled from separate longitude and latitude entity fields.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordSpatialGeometry/oneOf/0/properties/latitude_fieldLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordSpatialGeometry/oneOf/0/properties/longitude_fieldLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordSpatialGeometry/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordSpatialGeometry/oneOf/1/properties/crsNon-empty token without commas, whitespace, or control characters.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token
/$defs/recordSpatialGeometry/oneOf/1/properties/fieldLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordSpatialGeometry/oneOf/1/properties/kindSelects the GeoJSON, WKT, or WKB encoding used by the configured geometry field.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordSpdci/properties/expression_fieldsMaps SP-DCI expression input names to the entity fields available during expression evaluation.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordFieldMap
/$defs/recordSpdci/properties/identifiersMaps SP-DCI identifier names to the entity fields used to identify a record.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordFieldMap
/$defs/recordSpdci/properties/record_typeNon-empty token without commas, whitespace, or control characters.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token
/$defs/recordSpdci/properties/registryLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordSpdci/properties/registry_typeNon-empty token without commas, whitespace, or control characters.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token
/$defs/recordSpdci/properties/response_fieldsMaps SP-DCI response names to the entity fields returned for an authorized record.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordFieldMap
/$defs/recordsApi/properties/aggregatesMaps aggregate identifiers to governed aggregate definitions exposed by the records API.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/aggregates/additionalPropertiesGoverned aggregate definition with disclosure controls.
- Path kind
- map value
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordAggregate
/$defs/recordsApi/properties/aggregates/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordsApi/properties/attribute_release_profilesPurpose-bound, exact-one identity releases keyed by stable profile id. Generated Relay responses omit source metadata and are never cacheable.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordAttributeReleaseProfiles
/$defs/recordsApi/properties/filtersMaps filterable entity fields to the comparison operators the records API permits for each field.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/filters/additionalPropertiesAllowed operators for one queryable field.
- Path kind
- map value
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/filterOperators
/$defs/recordsApi/properties/filters/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordsApi/properties/paginationDefines the default and maximum row limits enforced by records API pagination.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/pagination/properties/default_limitSets the row limit applied when a records request does not supply its own limit.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/pagination/properties/max_limitCaps the row limit that any records request may select; it must be at least 2 when attribute-release profiles are configured so ambiguous subjects can be detected.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/projectionLists the entity fields that the records API is permitted to project into row responses.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/projection/itemsLowercase stable identifier used in project references.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordsApi/properties/purposesLists the bounded purpose identifiers accepted by this records API policy.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/purposes/itemsNon-empty token without commas, whitespace, or control characters.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token
/$defs/recordsApi/properties/relationshipsDeclares the bounded named relationships that records queries may follow between authored entities.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/relationships/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/relationships/additionalProperties/properties/concept_uriBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordsApi/properties/relationships/additionalProperties/properties/foreign_keyLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordsApi/properties/relationships/additionalProperties/properties/kindSelects whether one declared records relationship belongs to, has many, or has one target record.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/relationships/additionalProperties/properties/targetLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordsApi/properties/relationships/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordsApi/properties/required_principal_filtersLists principal-bound fields required for records queries; it must be empty when attribute-release profiles are configured because subject lookup cannot supply principal filters.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/fieldList
/$defs/recordsApi/properties/scopesGroups the authorization scopes required for records metadata, row access, aggregates, and evidence verification.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/scopes/properties/aggregateAuthorization scope token.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/scope
/$defs/recordsApi/properties/scopes/properties/evidence_verificationAuthorization scope token.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/scope
/$defs/recordsApi/properties/scopes/properties/metadataAuthorization scope token.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/scope
/$defs/recordsApi/properties/scopes/properties/rowsAuthorization scope token.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/scope
/$defs/recordsApi/properties/standardsDeclares whether this records API exposes its reviewed OGC Features and SP-DCI standards profiles.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/standards/properties/ogc_featuresDisables OGC API Features support or supplies the reviewed spatial profile used to enable it.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- composed schema
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/standards/properties/ogc_features/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/standards/properties/ogc_features/oneOf/1OGC API Features collection metadata and bounded geometry mapping.
- Path kind
- branch
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordSpatial
/$defs/recordsApi/properties/standards/properties/sp_dciDisables SP-DCI support or supplies the reviewed registry mapping used to enable it.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- composed schema
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/standards/properties/sp_dci/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsApi/properties/standards/properties/sp_dci/oneOf/1SP-DCI registry identity and field mappings for a records service.
- Path kind
- branch
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordSpdci
/$defs/recordsService/properties/access_rightsClassifies the records service as public, restricted, or non-public for catalog and access metadata.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsService/properties/apiRelay records API behavior, authorization, query bounds, and standards profiles.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordsApi
/$defs/recordsService/properties/conforms_toLists the standards or specifications to which the records service declares conformance.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsService/properties/conforms_to/itemsBounded human-readable project metadata.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordsService/properties/descriptionBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordsService/properties/entityLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/recordsService/properties/kindIdentifies this service declaration as a Relay records API backed by an authored entity.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsService/properties/ownerBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordsService/properties/sensitivityClassifies the overall sensitivity of records exposed by this service declaration.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/recordsService/properties/titleBounded human-readable project metadata.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/text
/$defs/recordsService/properties/update_frequencyDeclares the reviewed cadence at which the records service's backing data is updated.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/service/oneOf/0Notary evidence policy, consultations, claims, and registry-backed credential profiles. Source-free claims remain evaluation-only and cannot be selected by a credential profile.
- Path kind
- branch
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/evidenceService
/$defs/service/oneOf/1Relay records API backed by one authored materialized entity.
- Path kind
- branch
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/recordsService
/$defs/variables/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/variables/additionalProperties/properties/fromBinds one evidence variable to its caller-supplied request variable path.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/variables/additionalProperties/properties/typeDeclares the request variable as a date value for typed evidence evaluation.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/variables/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/anyOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/anyOf/0/properties/integrationsRequires at least one authored integration when the project satisfies the integration-content alternative.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/anyOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/anyOf/1/properties/entitiesRequires at least one authored entity when the project satisfies the entity-content alternative.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/anyOf/2Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/anyOf/2/properties/servicesRequires at least one authored service when the project satisfies the service-content alternative.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/entitiesMaterialized entity definitions keyed by project-local entity identifier.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/entities/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/entities/additionalProperties/properties/fileSelects the project-relative authored entity document for this project-local entity identifier.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- sensitive
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/relativePath
/properties/entities/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/properties/integrationsSource adaptation definitions keyed by project-local integration identifier.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/integrations/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/integrations/additionalProperties/properties/fileSelects the project-relative authored integration document for this project-local integration identifier.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- sensitive
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/relativePath
/properties/integrations/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/properties/registryStable identity of the Registry Stack project.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/registry/properties/idAssigns the stable project-local registry identifier used to bind generated product inputs and review artifacts.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/properties/servicesRelay records APIs and Notary evidence services exposed by the project.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/services/additionalPropertiesClosed choice between a Notary evidence service and a Relay records service.
- Path kind
- map value
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- reference to #/$defs/service
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/service
/properties/services/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/properties/starterImmutable provenance for a workspace initialized from a Registry Stack starter. The digest excludes this content_digest field and covers the starter's authored project files.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/starter/properties/content_digestDigest of the initialized starter authoring content, used to report later workspace divergence.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- sensitive
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/starter/properties/idRegistry Stack starter identifier.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/properties/starter/properties/releaseRegistry Stack release that supplied the starter.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token
/properties/versionProject authoring format version.
- Path kind
- property
- Purpose source
- schema description
- Scope
- The product-neutral project graph and the Relay or Notary services that consume its authored contracts.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- public
- Owners
- authoring contract; registry maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.project.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Revalidate and rebuild the project after changing this field; coordinate a deployment when generated product inputs change.
- Example guidance
- Use synthetic identifiers and values from a maintained golden workspace; never copy a private country contract into reference data.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
Environment configuration
Configuration surface: environments/*.yaml. This section contains 198 documented schema paths.
(document root)Binds a Registry Stack project to environment-specific services, sources, credentials, and deployment topology.
- Path kind
- root
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/ca/properties/fileNormalized absolute path without dot segments or duplicate separators.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/absolutePath
/$defs/ca/properties/generationRecords the operator-controlled trust-root generation used for explicit certificate-authority rotation.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/credential/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/credential/oneOf/0/properties/generationRecords the generation of the operator-managed basic-authentication credential references.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/credential/oneOf/0/properties/passwordReference to a process-environment variable; secret values are never authored here.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- secret reference
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/secret
/$defs/credential/oneOf/0/properties/usernameReference to a process-environment variable; secret values are never authored here.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- secret reference
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/secret
/$defs/credential/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/credential/oneOf/1/properties/generationRecords the generation of the operator-managed bearer-token credential reference.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/credential/oneOf/1/properties/tokenReference to a process-environment variable; secret values are never authored here.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- secret reference
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/secret
/$defs/credential/oneOf/2Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/credential/oneOf/2/properties/client_idReference to a process-environment variable; secret values are never authored here.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- secret reference
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/secret
/$defs/credential/oneOf/2/properties/client_secretReference to a process-environment variable; secret values are never authored here.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- secret reference
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/secret
/$defs/credential/oneOf/2/properties/generationRecords the generation of the operator-managed OAuth client credential references.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/credential/oneOf/3Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/credential/oneOf/3/properties/generationRecords the generation of the operator-managed API-key credential reference.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/credential/oneOf/3/properties/valueReference to a process-environment variable; secret values are never authored here.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- secret reference
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/secret
/$defs/endpoint/properties/allowed_private_cidrsExplicit private network ranges this source may resolve to.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/privateCidrs
/$defs/endpoint/properties/caPinned certificate-authority file and its rotation generation.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/ca
/$defs/endpoint/properties/generationRecords the operator-controlled private-endpoint generation used for explicit binding rotation.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/endpoint/properties/mtlsClient certificate and private-key reference for mutual TLS.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/mtls
/$defs/endpoint/properties/originHTTPS origin without path, query, or fragment.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/origin
/$defs/endpoint/properties/pathBinds a reviewed private endpoint path beneath its separately configured origin.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/entity/properties/columnsMaps authored entity field names to columns supplied by the environment-owned provider.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/entity/properties/columns/additionalPropertiesLowercase stable identifier used in project references.
- Path kind
- map value
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/entity/properties/columns/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/entity/properties/generationRecords the operator-controlled generation of this entity materialization binding.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/entity/properties/providerEnvironment-specific physical provider for a materialized entity.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/provider
/$defs/entity/properties/source_revisionRecords the operator-supplied revision label of the bound entity source.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/integration/properties/sourceRuntime source connection policy for one authored integration.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/source
/$defs/internalOrigin/anyOf/0HTTPS origin without path, query, or fragment.
- Path kind
- branch
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/origin
/$defs/internalOrigin/anyOf/1HTTP IP-loopback origin; public Relay and issuer fields restrict it to the local profile, while internal Notary-to-Relay connections allow it in any profile.
- Path kind
- branch
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/localLoopbackOrigin
/$defs/mtls/properties/certificate_fileNormalized absolute path without dot segments or duplicate separators.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/absolutePath
/$defs/mtls/properties/generationRecords the operator-controlled mutual-TLS generation used for explicit certificate and key rotation.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/mtls/properties/private_keyReference to a process-environment variable; secret values are never authored here.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- secret reference
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/secret
/$defs/oid4vci/properties/access_tokenDedicated Notary access-token signing key and published key identifier.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/oid4vci/properties/access_token/properties/signing_keyReference to a process-environment variable; secret values are never authored here.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- secret reference
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/secret
/$defs/oid4vci/properties/access_token/properties/signing_kidBounded visible-ASCII token, including full verification-method identifiers.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token2048
/$defs/oid4vci/properties/allowed_wallet_originsExact HTTPS browser origins admitted to the wallet-facing Notary routes.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/oid4vci/properties/allowed_wallet_origins/itemsHTTPS origin without path, query, or fragment.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/origin
/$defs/oid4vci/properties/authorization_serverPinned eSignet issuer and exact endpoints used for login and token validation.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/oid4vci/properties/authorization_server/properties/authorize_urlRelay authentication resource using HTTPS, or HTTP IP-loopback under the local profile.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- reference to #/$defs/relayResource
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/relayResource
/$defs/oid4vci/properties/authorization_server/properties/issuerRelay or issuer origin using HTTPS, or HTTP IP-loopback under the local profile.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- reference to #/$defs/relayOrigin
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/relayOrigin
/$defs/oid4vci/properties/authorization_server/properties/jwks_urlRelay authentication resource using HTTPS, or HTTP IP-loopback under the local profile.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- reference to #/$defs/relayResource
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/relayResource
/$defs/oid4vci/properties/authorization_server/properties/token_urlRelay authentication resource using HTTPS, or HTTP IP-loopback under the local profile.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- reference to #/$defs/relayResource
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/relayResource
/$defs/oid4vci/properties/authorization_server/properties/userinfo_urlRelay authentication resource using HTTPS, or HTTP IP-loopback under the local profile.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- reference to #/$defs/relayResource
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/relayResource
/$defs/oid4vci/properties/clienteSignet relying-party identity and dedicated private-key reference.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/oid4vci/properties/client/properties/idBounded visible-ASCII protocol token.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token256
/$defs/oid4vci/properties/client/properties/signing_keyReference to a process-environment variable; secret values are never authored here.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- secret reference
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/secret
/$defs/oid4vci/properties/client/properties/signing_kidBounded visible-ASCII token, including full verification-method identifiers.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token2048
/$defs/oid4vci/properties/credentialExisting project service and credential profile exposed through OID4VCI.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/oid4vci/properties/credential/properties/profileLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/oid4vci/properties/credential/properties/serviceLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/oid4vci/properties/public_base_urlRelay or issuer origin using HTTPS, or HTTP IP-loopback under the local profile.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- reference to #/$defs/relayOrigin
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/relayOrigin
/$defs/oid4vci/properties/redirect_uriRelay authentication resource using HTTPS, or HTTP IP-loopback under the local profile.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- reference to #/$defs/relayResource
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/relayResource
/$defs/oid4vci/properties/sensitive_state_keyReference to a process-environment variable; secret values are never authored here.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- secret reference
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/secret
/$defs/oid4vci/properties/subjectVerified eSignet userinfo claim bound exactly to the credential subject identifier.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/oid4vci/properties/subject/properties/id_typeBounded visible-ASCII protocol token.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token256
/$defs/oid4vci/properties/subject/properties/token_claimBounded visible-ASCII protocol token.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token256
/$defs/oid4vci/properties/tx_codeTransaction-code policy. Omit for the secure required-PIN default. Set required=false only for a bounded bearer-offer interoperability profile; the compiler fixes the offer lifetime at 300 seconds.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/oid4vci/properties/tx_code/properties/requiredStates whether OID4VCI authorization requires a transaction code before credential issuance.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- schema default true
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/privateCidrs/itemsDefines the contract shared by each ordered item in the enclosing authored list.
- Path kind
- array item
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/provider/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/provider/oneOf/0/properties/delimiterSelects the byte used to delimit fields in the bound CSV source.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/provider/oneOf/0/properties/header_rowSelects the one-based CSV row containing source column headers.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/provider/oneOf/0/properties/pathNormalized absolute path without dot segments or duplicate separators.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/absolutePath
/$defs/provider/oneOf/0/properties/quoteSelects the byte used to quote fields in the bound CSV source.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/provider/oneOf/0/properties/typeSelects CSV as the environment-owned materialization provider for an authored entity.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/provider/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/provider/oneOf/1/properties/data_rangeRestricts entity materialization to the reviewed range within the selected worksheet.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/provider/oneOf/1/properties/header_rowSelects the one-based XLSX row containing source column headers.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/provider/oneOf/1/properties/pathNormalized absolute path without dot segments or duplicate separators.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/absolutePath
/$defs/provider/oneOf/1/properties/project_fileBinds a contained project-relative workbook for offline preflight and read-only runtime mounting without emitting the authoring path into Relay configuration.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/relativePath
/$defs/provider/oneOf/1/properties/sheetNames the worksheet read from the environment-owned XLSX source.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/provider/oneOf/1/properties/typeSelects XLSX as the environment-owned materialization provider for an authored entity.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/provider/oneOf/2Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/provider/oneOf/2/properties/pathNormalized absolute path without dot segments or duplicate separators.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/absolutePath
/$defs/provider/oneOf/2/properties/typeSelects Parquet as the environment-owned materialization provider for an authored entity.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/provider/oneOf/3Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/provider/oneOf/3/properties/connectionReference to a process-environment variable; secret values are never authored here.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- secret reference
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/secret
/$defs/provider/oneOf/3/properties/schemaPortable unquoted PostgreSQL schema or table identifier.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/postgresIdentifier
/$defs/provider/oneOf/3/properties/tablePortable unquoted PostgreSQL schema or table identifier.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/postgresIdentifier
/$defs/provider/oneOf/3/properties/typeSelects PostgreSQL as the environment-owned materialization provider for an authored entity.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/relayOrigin/anyOf/0HTTPS origin without path, query, or fragment.
- Path kind
- branch
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/origin
/$defs/relayOrigin/anyOf/1HTTP IP-loopback origin; public Relay and issuer fields restrict it to the local profile, while internal Notary-to-Relay connections allow it in any profile.
- Path kind
- branch
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/localLoopbackOrigin
/$defs/relayResource/anyOf/0Exact HTTPS resource without query or fragment.
- Path kind
- branch
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/httpsResource
/$defs/relayResource/anyOf/1HTTP IP-loopback resource accepted only with the local deployment profile.
- Path kind
- branch
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/localLoopbackResource
/$defs/secret/properties/secretNames the operator-managed environment secret reference without containing the secret value.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- secret reference
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/service/properties/serviceLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/$defs/source/properties/allowed_private_cidrsExplicit private network ranges this source may resolve to.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/privateCidrs
/$defs/source/properties/caPinned certificate-authority file and its rotation generation.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/ca
/$defs/source/properties/concurrencyCaps the number of requests that may be in flight concurrently for this source.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/source/properties/credentialOne supported source credential shape, containing references rather than values.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/credential
/$defs/source/properties/jwksSecurity-bound HTTPS endpoint with optional private-network, CA, and mTLS policy.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/endpoint
/$defs/source/properties/mtlsClient certificate and private-key reference for mutual TLS.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/mtls
/$defs/source/properties/oauthSecurity-bound HTTPS endpoint with optional private-network, CA, and mTLS policy.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/endpoint
/$defs/source/properties/originHTTPS origin without path, query, or fragment.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/origin
/$defs/source/properties/rateDefines the per-minute request rate and burst bounds applied to one environment source.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/source/properties/rate/properties/burstCaps the short request burst permitted by the source rate limiter.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/source/properties/rate/properties/per_minuteCaps the number of requests permitted to this source during one minute.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/$defs/source/properties/timeoutOptionally narrows one environment source request to a positive timeout no greater than twenty seconds.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/0/elseDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/0/else/notDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/0/ifDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/0/if/properties/deploymentMatches environments whose deployment declaration enables Relay so the corresponding Relay binding is required.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/0/thenDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/1/ifDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/1/thenDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/1/then/properties/deploymentRequires both Relay and Notary deployment services when a Notary-to-Relay binding is present.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/2Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/2/ifDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/2/thenDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/2/then/properties/deploymentRequires the Relay deployment service when Relay state storage is configured.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/3Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/3/ifDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/3/thenDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/3/then/properties/deploymentRequires the Notary deployment service when Notary state storage is configured.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/4Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/4/ifDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/4/thenDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/4/then/properties/deploymentRequires the Notary deployment service when a Notary CEL worker memory bound is configured.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/5Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/5/elseDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/5/else/properties/callersWhen callers are authored without OID4VCI, requires the caller map to contain at least one binding; cross-file validation separately requires callers for Notary environments and rejects them for Relay-only topology.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/5/ifDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/5/thenDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/5/then/properties/deploymentRequires the Notary deployment service when OID4VCI issuance is configured.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/6Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/6/elseDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/6/else/properties/oid4vciApplies non-local HTTPS constraints to public OID4VCI endpoints.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/6/else/properties/oid4vci/properties/authorization_serverApplies non-local HTTPS constraints to all configured OID4VCI authorization-server endpoints.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/6/else/properties/oid4vci/properties/authorization_server/properties/authorize_urlExact HTTPS resource without query or fragment.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/httpsResource
/allOf/6/else/properties/oid4vci/properties/authorization_server/properties/issuerHTTPS origin without path, query, or fragment.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/origin
/allOf/6/else/properties/oid4vci/properties/authorization_server/properties/jwks_urlExact HTTPS resource without query or fragment.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/httpsResource
/allOf/6/else/properties/oid4vci/properties/authorization_server/properties/token_urlExact HTTPS resource without query or fragment.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/httpsResource
/allOf/6/else/properties/oid4vci/properties/authorization_server/properties/userinfo_urlExact HTTPS resource without query or fragment.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/httpsResource
/allOf/6/else/properties/oid4vci/properties/public_base_urlHTTPS origin without path, query, or fragment.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/origin
/allOf/6/else/properties/oid4vci/properties/redirect_uriExact HTTPS resource without query or fragment.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/httpsResource
/allOf/6/else/properties/relayApplies non-local HTTPS constraints to the Relay origin, issuer, and key-set bindings.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/6/else/properties/relay/notDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/6/else/properties/relay/properties/issuerHTTPS origin without path, query, or fragment.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/origin
/allOf/6/else/properties/relay/properties/jwks_urlExact HTTPS resource without query or fragment.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/httpsResource
/allOf/6/else/properties/relay/properties/originHTTPS origin without path, query, or fragment.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/origin
/allOf/6/ifDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/6/if/properties/deploymentMatches the local deployment profile before relaxing public endpoint transport constraints.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/allOf/6/if/properties/deployment/properties/profileSelects the local-profile condition used by the environment transport-validation branch.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/callersNotary API-key caller identities and the scopes each identity receives.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/callers/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/callers/additionalProperties/properties/api_key_fingerprintNames the secret reference used to verify one caller API key; neither the key nor fingerprint value is authored here.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- secret reference
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/secret
/properties/callers/additionalProperties/properties/scopesNarrows one caller to the explicitly reviewed service scopes available in this environment.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/callers/additionalProperties/properties/scopes/itemsDefines the contract shared by each ordered item in the enclosing authored list.
- Path kind
- array item
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/callers/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/properties/deploymentProducts deployed in this environment and the operational profile they use.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/deployment/anyOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/deployment/anyOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- structural
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/deployment/properties/notaryBinds an authored product role to a deployed service identifier.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/service
/properties/deployment/properties/profileSelects the deployment assurance profile whose service and transport conditions the environment must satisfy.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/deployment/properties/relayBinds an authored product role to a deployed service identifier.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/service
/properties/entitiesEnvironment-specific source bindings keyed by entity identifier.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/entities/additionalPropertiesMaps an authored entity to provider columns and immutable source-generation identifiers.
- Path kind
- map value
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/entity
/properties/entities/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/properties/integrationsEnvironment bindings keyed by authored integration identifier.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/integrations/additionalPropertiesEnvironment binding for an authored source integration.
- Path kind
- map value
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/integration
/properties/integrations/propertyNamesLowercase stable identifier used in project references.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/stableId
/properties/issuanceNotary issuer and signing-key bindings for credential issuance.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/issuance/properties/algorithmCredential issuer signing algorithm. Holder proof remains EdDSA with did:jwk.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- schema default "EdDSA"
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/issuance/properties/generationRecords the operator-controlled issuance-key generation used for explicit rotation and rollback checks.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/issuance/properties/issuerBinds the operator-approved credential issuer identifier without granting claim or disclosure authority.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/issuance/properties/signing_keyNames the operator-managed secret reference for credential signing; the signing key value is never authored or reported.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- secret reference
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/secret
/properties/issuance/properties/signing_kidSelects the reviewed signing-key identifier exposed in issued credential metadata without containing private key material.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token2048
/properties/notary_celOptional per-worker data/address-space ceiling for dedicated Notary CEL processes. The Notary default is 134217728 bytes; 1073741824 is the maximum emulation-compatible exception and remains a limit, not an allocation.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/notary_cel/properties/worker_memory_bytesCaps the memory available to one isolated Notary CEL worker.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/notary_relayDeployment-internal Relay connection, Notary workload identity, and token file used only when Notary consults Relay.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/notary_relay/properties/base_urlBinds Notary to the operator-reviewed Relay origin used for governed evidence consultations.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- reference to #/$defs/internalOrigin
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/internalOrigin
/properties/notary_relay/properties/token_fileSelects the operator-managed token-file binding for Notary-to-Relay authentication without exposing its contents.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/notary_relay/properties/workload_client_idIdentifies the Notary workload client authorized to request reviewed Relay consultations.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/notary_stateOptional deployment binding for Notary-owned PostgreSQL state transport trust.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/notary_state/properties/postgresqlSelects the PostgreSQL trust binding used by Notary state storage.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/notary_state/properties/postgresql/properties/root_certificate_pathBinds Notary state storage to an operator-managed PostgreSQL trust root at a deployment-local path.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/absolutePath
/properties/oid4vciExplicit registry-backed holder-wallet OID4VCI binding for one authored Notary credential profile.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/oid4vci
/properties/relayPublic Relay identity and token-validation settings for a Relay deployment.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/relay/properties/allowed_clientsNarrows Relay authentication to the operator-reviewed client identifiers listed for this environment.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/relay/properties/allowed_clients/itemsDefines the contract shared by each ordered item in the enclosing authored list.
- Path kind
- array item
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/relay/properties/audienceBinds the token audience Relay requires so tokens issued for another service are rejected.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/relay/properties/issuerBinds the expected token issuer for Relay authentication in this deployment environment.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- reference to #/$defs/relayOrigin
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/relayOrigin
/properties/relay/properties/jwks_urlBinds the operator-reviewed key-set endpoint Relay uses to verify caller tokens.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- reference to #/$defs/relayResource
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/relayResource
/properties/relay/properties/local_api_keysDeclares synthetic API-key principals only for the local profile; Registryctl generates raw keys privately and emits only their fingerprints to Relay.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/relay/properties/local_api_keys/properties/match_principalBinds the synthetic local caller whose reviewed identifier matches one starter row; this identifier is not a raw key or a source value.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token256
/properties/relay/properties/local_api_keys/properties/no_match_principalBinds the synthetic local caller whose reviewed identifier intentionally matches no starter row so an empty result is maintained.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/token256
/properties/relay/properties/local_api_keys/properties/scopesLimits both generated local API-key callers to the explicitly reviewed service scopes needed by the maintained checks.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/relay/properties/local_api_keys/properties/scopes/itemsDefines the contract shared by each ordered item in the enclosing authored list.
- Path kind
- array item
- Purpose source
- structural taxonomy
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/relay/properties/originBinds the externally visible Relay origin reviewed by the operator and local network policy.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- reference to #/$defs/relayOrigin
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/relayOrigin
/properties/relay_stateOptional deployment binding for Relay-owned consultation PostgreSQL state transport trust.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/relay_state/properties/postgresqlSelects the PostgreSQL trust binding used by Relay state storage.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- internal
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
/properties/relay_state/properties/postgresql/properties/root_certificate_pathBinds Relay state storage to an operator-managed PostgreSQL trust root at a deployment-local path.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- sensitive
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
- Local schema reference
/$defs/absolutePath
/properties/versionEnvironment authoring format version.
- Path kind
- property
- Purpose source
- schema description
- Scope
- Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- environment bound
- Sensitivity
- public
- Owners
- deployment security; security maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, operator preflight, product build
- Diagnostic
registryctl.authoring.environment.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.
- Example guidance
- Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation
Integration configuration
Configuration surface: integrations/*/integration.yaml. This section contains 142 documented schema paths.
(document root)Defines a product-neutral source adaptation contract using bounded HTTP, Rhai script, or exact snapshot capabilities.
- Path kind
- root
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/allowRule/properties/methodSelects the GET or POST method permitted by one reviewed source allow rule.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/allowRule/properties/pathDefines one reviewed source path template; concrete private endpoints and identifiers remain environment-owned.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- sensitive
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/allowRule/properties/semanticsDeclares that the permitted source operation has read-only semantics.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/capability/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/capability/oneOf/0/properties/httpSelects the single-request declarative HTTP capability and its expected response semantics.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/capability/oneOf/0/properties/http/properties/requestBounded read-only HTTP request template.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/httpRequest
/$defs/capability/oneOf/0/properties/http/properties/responseRules for translating upstream status and body cardinality into normalized outcomes.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/httpResponse
/$defs/capability/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/capability/oneOf/1/properties/scriptSelects the reviewed project-relative script capability and its optional modules.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/capability/oneOf/1/properties/script/properties/fileProject-relative path without traversal or duplicate separators.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- sensitive
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/relativePath
/$defs/capability/oneOf/1/properties/script/properties/modulesLists the reviewed project-relative modules available to the integration script.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- sensitive
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/capability/oneOf/1/properties/script/properties/modules/itemsProject-relative path without traversal or duplicate separators.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/relativePath
/$defs/capability/oneOf/2Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/capability/oneOf/2/properties/snapshotSelects an offline entity snapshot capability with exact input matching and freshness control.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/capability/oneOf/2/properties/snapshot/properties/entityLowercase stable identifier used in project references.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/stableId
/$defs/capability/oneOf/2/properties/snapshot/properties/exactMaps entity fields to integration inputs that must match exactly in the snapshot lookup.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/capability/oneOf/2/properties/snapshot/properties/exact/additionalPropertiesReference to a declared integration input.
- Path kind
- map value
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/inputReference
/$defs/capability/oneOf/2/properties/snapshot/properties/freshnessSets the maximum accepted age of the materialized entity snapshot within the product-owned 31-day ceiling.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/0/properties/typeSelects an unauthenticated, basic-authentication, or static-bearer credential interface.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/1/properties/max_value_bytesCaps the credential value size accepted by the fixed-header API-key interface.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/1/properties/nameDeclares the fixed HTTP header name used by the API-key credential interface.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/1/properties/typeSelects the fixed-header API-key credential interface for this source contract.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/2Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/2/properties/max_value_bytesCaps the credential value size accepted by the fixed-query API-key interface.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/2/properties/nameDeclares the fixed query parameter name used by the API-key credential interface.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/2/properties/typeSelects the fixed-query-parameter API-key credential interface for this source contract.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/3Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/3/properties/audienceConstrains OAuth token acquisition to the reviewed source audience and is treated as sensitive operational metadata.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- sensitive
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/3/properties/refresh_skewSets a positive refresh interval below sixty seconds so a cached OAuth credential retains usable lifetime.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/3/properties/requestSelects form-encoded or JSON token requests for the OAuth client-credentials interface.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/3/properties/response_profileRequires the bounded OAuth bearer-token response profile supported by the source adapter.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/3/properties/scopeDeclares the bounded OAuth scope string requested for this source credential.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/credential/oneOf/3/properties/typeSelects the OAuth 2.0 client-credentials interface for source authentication.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/httpRequest/properties/bodyDefines the optional authored body template sent by the declarative HTTP request.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/httpRequest/properties/headersMaps reviewed request header names to authored values and input substitutions.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/httpRequest/properties/headers/additionalPropertiesRequest value supplied from a declared input or an authored scalar literal.
- Path kind
- map value
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- boolean or integer or string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/inputOrLiteral
/$defs/httpRequest/properties/methodSelects the single GET or POST request performed by a declarative HTTP capability.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/httpRequest/properties/pathDefines the reviewed source path template used by the declarative HTTP request.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- sensitive
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/httpRequest/properties/queryMaps reviewed query parameter names to authored request values and input substitutions.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/httpRequest/properties/query/additionalPropertiesRequest value supplied from a declared input or an authored scalar literal.
- Path kind
- map value
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- boolean or integer or string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/inputOrLiteral
/$defs/httpRequest/properties/semanticsDeclares that the declarative HTTP request has read-only source semantics.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/httpResponse/properties/ambiguousLists HTTP response statuses that produce the integration's ambiguous outcome.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/httpResponse/properties/ambiguous/itemsDefines the contract shared by each ordered item in the enclosing authored list.
- Path kind
- array item
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/httpResponse/properties/no_matchLists HTTP response statuses that produce the integration's no-match outcome.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/httpResponse/properties/no_match/itemsDefines the contract shared by each ordered item in the enclosing authored list.
- Path kind
- array item
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/httpResponse/properties/shapeDeclares whether a successful response is a singleton or a bounded collection.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/httpResponse/properties/shape/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/httpResponse/properties/shape/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/httpResponse/properties/shape/oneOf/1/properties/cardinalityRequires two-record probing so collection results distinguish one match from ambiguity.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/httpResponse/properties/shape/oneOf/1/properties/recordsSelects the canonical response location containing collection records.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/input/properties/canonicalizationSelects the reviewed normalization rule applied before an input is compared, interpolated, or sent to a source.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/input/properties/formatApplies the full-date semantic format to a string-valued integration input.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/input/properties/maxLengthCaps a string-valued integration input at 1,024 Unicode scalar values, deriving its conservative 4,096-byte UTF-8 ceiling.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/input/properties/maximumSets the inclusive upper bound accepted for an integer-valued integration input.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/input/properties/minLengthSets the minimum character length accepted for a string-valued integration input.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/input/properties/minimumSets the inclusive lower bound accepted for an integer-valued integration input.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/input/properties/patternConstrains a string-valued integration input with the authored regular expression.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/input/properties/roleDeclares how one typed authoring input participates in source lookup, selection, or result shaping.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/input/properties/typeDeclares the closed scalar or array type accepted for one integration input.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/scalarType
/$defs/inputOrLiteral/oneOf/0Reference to a declared integration input.
- Path kind
- branch
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/inputReference
/$defs/inputOrLiteral/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- boolean or integer or string
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/inputReference/properties/inputPortable lowercase name for an integration input or output.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/inputName
/$defs/integrationRequestByteSize/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/integrationRequestByteSize/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/integrationResponseByteSize/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/integrationResponseByteSize/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/integrationSourceByteSize/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/integrationSourceByteSize/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/limits/properties/callsCaps the number of high-level source calls available to a script integration.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/limits/properties/deadlineCaps total integration execution time with a positive duration no greater than twenty seconds.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/limits/properties/request_bytesMaximum aggregate author-controlled request bytes for one execution, defaulting to 64 KiB and capped at 1 MiB. Use a positive byte integer or canonical KiB/MiB value.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer or string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- schema default "64KiB"
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/integrationRequestByteSize
/$defs/limits/properties/source_bytesMaximum aggregate source-response bytes for one execution, defaulting to 2 MiB and capped at 16 MiB. Use a positive byte integer or canonical KiB/MiB value.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer or string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- schema default "2MiB"
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/integrationSourceByteSize
/$defs/notApplicable/properties/ambiguityWhy the reviewed source contract cannot produce more than one matching record.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/notApplicableReason
/$defs/notApplicable/properties/subject_mismatchWhy the reviewed response contract contains no identifier comparable with a requested selector.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/notApplicableReason
/$defs/notApplicableReason/properties/rationaleWhy the named normally required outcome cannot occur for this source contract.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/notApplicableReason/properties/request_fixtureFixture name containing the supporting bounded source request.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/stableId
/$defs/output/properties/formatApplies the full-date semantic format to a string-valued integration output.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/output/properties/maxLengthCaps the character length produced for a string-valued integration output.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/output/properties/maximumSets the inclusive upper bound produced for an integer-valued integration output.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/output/properties/minimumSets the inclusive lower bound produced for an integer-valued integration output.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/output/properties/typeSupported scalar type, optionally paired with null for nullable values.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/scalarType
/$defs/output/properties/x-registry-sourceSelects the canonical source-response location from which the HTTP output is extracted.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/protocol/properties/signed_dciEnables the bounded signed DCI search helper and declares its protocol and selector bindings.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/protocol/properties/signed_dci/properties/jwks_profileSelects the supported RSA signing-key-set profile used to verify signed DCI responses.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/protocol/properties/signed_dci/properties/localeDeclares the language or locale tag carried by signed DCI search requests.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/protocol/properties/signed_dci/properties/pathDeclares the exact private source path used for signed DCI search requests.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- sensitive
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/protocol/properties/signed_dci/properties/profileSelects the supported DCI search request profile used by the signed protocol helper.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/protocol/properties/signed_dci/properties/receiverDeclares the signed DCI receiver identifier included in protocol requests.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/protocol/properties/signed_dci/properties/record_typeDeclares the record type requested through the signed DCI search profile.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/protocol/properties/signed_dci/properties/registry_typeDeclares the registry type requested through the signed DCI search profile.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/protocol/properties/signed_dci/properties/selectorsMaps every selector input to its signed DCI request field and response location.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/protocol/properties/signed_dci/properties/selectors/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/protocol/properties/signed_dci/properties/selectors/additionalProperties/properties/fieldDeclares the signed DCI identifier field bound to one selector input.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/protocol/properties/signed_dci/properties/selectors/additionalProperties/properties/response_pointerSelects the canonical signed-record response location used to recover one selector value.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/protocol/properties/signed_dci/properties/selectors/propertyNamesPortable lowercase name for an integration input or output.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/inputName
/$defs/protocol/properties/signed_dci/properties/senderDeclares the signed DCI sender identifier included in protocol requests.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/scalarType/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/scalarType/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- array
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/scalarType/oneOf/1/prefixItems/0Defines the contract shared by each ordered item in the enclosing authored list.
- Path kind
- array item
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/scalarType/oneOf/1/prefixItems/1Defines the contract shared by each ordered item in the enclosing authored list.
- Path kind
- array item
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/source/properties/allowConstrains source access to the explicitly reviewed method and path templates in this integration contract.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/source/properties/allow/itemsOne read-only upstream method and path pattern the adapter may call.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/allowRule
/$defs/source/properties/authDeclares the credential interface the source contract permits without embedding an environment credential value.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/credential
/$defs/source/properties/productNames the source product whose version labels are classified by this integration contract.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/source/properties/protocolOptional interoperable protocol profiles layered over the source transport.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/protocol
/$defs/source/properties/request_headersLists the bounded source request header names available to the integration adapter.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/source/properties/request_headers/itemsDefines the contract shared by each ordered item in the enclosing authored list.
- Path kind
- array item
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/source/properties/responseDefines the reviewed source response representation and optional byte bound.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/source/properties/response/properties/formatSelects JSON decoding or text handling for reviewed source responses.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/source/properties/response/properties/max_bytesMaximum bytes accepted from one source response, defaulting to 512 KiB and capped at 8 MiB. Use a positive byte integer or canonical KiB/MiB value.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer or string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- schema default "512KiB"
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/integrationResponseByteSize
/$defs/source/properties/response_headersLists the bounded source response header names available to the integration adapter.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/source/properties/response_headers/itemsDefines the contract shared by each ordered item in the enclosing authored list.
- Path kind
- array item
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/source/properties/versionsSource versions tested by the project and versions explicitly accepted as unverified.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/versions
/$defs/versionList/itemsDefines the contract shared by each ordered item in the enclosing authored list.
- Path kind
- array item
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/versions/anyOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/versions/anyOf/0/properties/testedRequires at least one source product version to be classified as tested in this integration contract.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/versions/anyOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/versions/anyOf/1/properties/unverifiedRequires at least one source product version to be classified as unverified in this integration contract.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/$defs/versions/properties/testedBounded list of source version labels.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/versionList
/$defs/versions/properties/unverifiedBounded list of source version labels.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/versionList
/properties/capabilityExactly one bounded execution mechanism for the source adaptation.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/capability
/properties/idStable project-local identifier for the integration.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/stableId
/properties/inputTyped selector and parameter inputs accepted by this integration.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/properties/input/additionalPropertiesType, validation, and canonicalization rules for one authored input.
- Path kind
- map value
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/input
/properties/input/propertyNamesPortable lowercase name for an integration input or output.
- Path kind
- map key
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/inputName
/properties/limitsOptional tighter resource limits for one integration execution.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/limits
/properties/not_applicableExplicit rationale and request-fixture evidence for a normally required outcome that the source contract cannot produce.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/notApplicable
/properties/outputsNamed typed outputs, or a shorthand list of output names inferred by the authoring compiler.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- array or object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/properties/outputs/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/properties/outputs/oneOf/0/additionalPropertiesType and optional source pointer for one normalized integration output.
- Path kind
- map value
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/output
/properties/outputs/oneOf/0/propertyNamesNames one author-controlled entry in the enclosing typed map; the key is data, not an extension field.
- Path kind
- map key
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- composed schema
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/properties/outputs/oneOf/0/propertyNames/allOf/0Portable lowercase name for an integration input or output.
- Path kind
- branch
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/inputName
/properties/outputs/oneOf/0/propertyNames/allOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/properties/outputs/oneOf/0/propertyNames/allOf/1/notDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/properties/outputs/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- array
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/properties/outputs/oneOf/1/itemsPortable lowercase name for an integration input or output.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/inputName
/properties/revisionMonotonically increasing revision of this integration contract.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
/properties/sourceOptional source product metadata and transport policy; capabilities remain product-neutral.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
- Local schema reference
/$defs/source
/properties/versionIntegration authoring format version.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A reviewed source contract, bounded adaptation capability, typed inputs and outputs, and offline verification requirements.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- public
- Owners
- integration contract; integration maintainers
- Products
- registryctl, relay, notary, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, fixture execution, product build
- Diagnostic
registryctl.authoring.integration.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Update affected fixtures and rebuild the project; re-review authority whenever source access, credentials, or bounds change.
- Example guidance
- Use a bounded synthetic source contract and fixture-safe values that demonstrate behavior without revealing a country endpoint or record.
- Consumers
- registryctl authoring, registry relay, registry notary, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, notary config, fixture report, field reference
- Review classes
- contract, security, privacy, relay, notary, compatibility, documentation, testing
Fixture configuration
Configuration surface: integrations/*/fixtures/*.yaml. This section contains 62 documented schema paths.
(document root)Defines one synthetic, deterministic integration scenario for offline adapter verification.
- Path kind
- root
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/expectation/properties/claimsStates the synthetic Notary claim outcomes expected after the reviewed Relay consultation behavior.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/expectation/properties/errorStates the bounded error identifier expected from a failing offline fixture.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/expectation/properties/outcomeStates whether the offline fixture is expected to match, find no match, or remain ambiguous.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/expectation/properties/outputsMaps integration output names to the synthetic values expected after fixture execution.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/fixtureBody/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/fixtureBody/oneOf/0/properties/fileSelects a fixture-local synthetic body file beneath the reserved bodies directory.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/fixtureBody/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/fixtureBody/oneOf/1/notDocuments a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedClaimRef/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedClaimRef/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedClaimRef/oneOf/1/properties/idNames one authored claim requested by this fixture witness.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedClaimRef/oneOf/1/properties/versionPins the requested claim to one authored claim-policy version.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedIdentifier/properties/schemeNames the authored identifier scheme selected by a consultation input mapping.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedIdentifier/properties/valueSupplies the synthetic string value bound to this identifier scheme.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedRequest/properties/claimsLists the authored claims evaluated by this synthetic request witness.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedRequest/properties/claims/itemsA requested claim ID, optionally pinned to one authored claim version.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object or string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
- Local schema reference
/$defs/governedClaimRef
/$defs/governedRequest/properties/disclosureSelects the disclosure mode requested from the authored claim policy.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedRequest/properties/formatSelects the claim-result media type requested from the governed Notary path.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedRequest/properties/purposeNames the authored service purpose exercised by this synthetic request witness.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedRequest/properties/targetThe synthetic subject target presented to the same governed request boundary as a live Notary evaluation.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
- Local schema reference
/$defs/governedTarget
/$defs/governedRequest/properties/variablesSupplies synthetic date variables to the governed evaluation request.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedRequest/properties/variables/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedRequest/properties/variables/propertyNamesNames one author-controlled entry in the enclosing typed map; the key is data, not an extension field.
- Path kind
- map key
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- schema-constrained value
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedTarget/properties/attributesSupplies independently authored typed target attributes for consultation input mapping.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedTarget/properties/attributes/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- boolean or integer or null or string
- Requiredness
- not applicable
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedTarget/properties/idSupplies an optional synthetic direct target identifier.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedTarget/properties/identifiersSupplies independently authored synthetic identifiers for consultation input mapping.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/governedTarget/properties/identifiers/itemsOne synthetic target identifier with an authored scheme and string value.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
- Local schema reference
/$defs/governedIdentifier
/$defs/governedTarget/properties/typeNames the authored target entity type used for claim evaluation.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/interaction/properties/expectExact HTTP request shape the adapter must produce.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
- Local schema reference
/$defs/request
/$defs/interaction/properties/respondSynthetic HTTP response or timeout returned to the adapter.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
- Local schema reference
/$defs/response
/$defs/request/properties/bodyDefines the synthetic request body expectation or fixture-local file reference without reading a source.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
- Local schema reference
/$defs/fixtureBody
/$defs/request/properties/headersStates the synthetic request headers expected from one offline fixture interaction.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/request/properties/headers/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/request/properties/headers/propertyNamesNames one author-controlled entry in the enclosing typed map; the key is data, not an extension field.
- Path kind
- map key
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- schema-constrained value
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/request/properties/methodStates the synthetic request method expected from the offline integration fixture.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/request/properties/pathStates the synthetic request path expected from the offline integration fixture.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/request/properties/queryStates the synthetic query parameters expected from one offline fixture interaction.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/request/properties/query/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- array or boolean or integer or null or string
- Requiredness
- not applicable
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/request/properties/query/additionalProperties/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- boolean or integer or null or string
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/request/properties/query/additionalProperties/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- array
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/request/properties/query/additionalProperties/oneOf/1/itemsDefines the contract shared by each ordered item in the enclosing authored list.
- Path kind
- array item
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- boolean or integer or null or string
- Requiredness
- not applicable
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/response/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/response/oneOf/0/properties/bodyDefines the synthetic response body returned by the offline fixture harness to the integration.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
- Local schema reference
/$defs/fixtureBody
/$defs/response/oneOf/0/properties/headersDefines the synthetic HTTP response headers returned by the offline fixture harness.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/response/oneOf/0/properties/headers/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/response/oneOf/0/properties/statusSelects the synthetic HTTP status returned by the offline fixture harness.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/response/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/$defs/response/oneOf/1/properties/timeoutRecords bounded synthetic timeout intent; offline execution returns the timeout outcome without waiting for the authored interval.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/properties/classificationDeclares that fixture data is synthetic and safe for offline testing.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- public
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/properties/expectObservable adapter result required for the scenario to pass.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
- Local schema reference
/$defs/expectation
/properties/inputTyped consultation inputs supplied to the adapter under test.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/properties/input/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- boolean or integer or null or string
- Requiredness
- not applicable
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/properties/input/propertyNamesNames one author-controlled entry in the enclosing typed map; the key is data, not an extension field.
- Path kind
- map key
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- schema-constrained value
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/properties/interactionsOrdered upstream request and response exchanges expected during execution.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/properties/interactions/itemsOne expected upstream request paired with its synthetic response.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
- Local schema reference
/$defs/interaction
/properties/nameHuman-readable scenario name shown in test output.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- public
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/properties/requestOptional independently authored synthetic Notary request used to prove the request-to-consultation binding before Relay access.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
- Local schema reference
/$defs/governedRequest
/properties/variablesNamed date values available to deterministic fixture interpolation.
- Path kind
- property
- Purpose source
- schema description
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/properties/variables/additionalPropertiesDefines the contract shared by every author-controlled value in the enclosing typed map.
- Path kind
- map value
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
/properties/variables/propertyNamesNames one author-controlled entry in the enclosing typed map; the key is data, not an extension field.
- Path kind
- map key
- Purpose source
- structural taxonomy
- Scope
- An offline synthetic interaction and expected outcome used to verify one integration contract without source access.
- Type
- schema-constrained value
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- environment independent
- Configuration state
- authored
- Sensitivity
- redacted fixture
- Owners
- fixture harness; test maintainers
- Products
- registryctl, editor, docs
- Validation stages
- json schema, rust deserialization, fixture execution
- Diagnostic
registryctl.authoring.fixture.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- update fixtures. Update the fixture when the reviewed integration contract changes, while preserving synthetic and non-sensitive test data.
- Example guidance
- Use unmistakably synthetic inputs, requests, responses, claims, and errors; fixtures must not contain copied personal or source data.
- Consumers
- registryctl authoring, editor tooling, docs generator
- Generated artifacts
- editor schemas, fixture report, field reference
- Review classes
- contract, privacy, compatibility, documentation, testing
Entity configuration
Configuration surface: entities/*.yaml. This section contains 35 documented schema paths.
(document root)Defines a bounded, materialized entity that Relay can query without coupling the project to a specific source product.
- Path kind
- root
- Purpose source
- schema description
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/fieldSchema/properties/constRequires one entity field to equal the single authored value supplied by this schema constraint.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/fieldSchema/properties/enumRestricts one entity field to the unique authored values listed by this schema constraint.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/fieldSchema/properties/formatAdds a reviewed semantic format constraint to one string-valued entity field.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- schema-constrained value
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/fieldSchema/properties/maxLengthCaps the character length accepted for one string-valued entity field.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/fieldSchema/properties/maximumSets the inclusive upper numeric bound accepted for one entity field.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/fieldSchema/properties/minLengthSets the minimum character length accepted for one string-valued entity field.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/fieldSchema/properties/minimumSets the inclusive lower numeric bound accepted for one entity field.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/fieldSchema/properties/patternConstrains a string-valued entity field with the authored regular expression.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/fieldSchema/properties/typeDeclares the closed scalar, array, or object type accepted for one entity field.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
- Local schema reference
/$defs/scalarType
/$defs/objectSchema/properties/additionalPropertiesControls whether the entity object accepts fields outside its declared closed property set.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/objectSchema/properties/propertiesMaps every declared entity property name to its closed field schema.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/objectSchema/properties/properties/additionalPropertiesBounded schema keywords supported for one scalar materialized field.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
- Local schema reference
/$defs/fieldSchema
/$defs/objectSchema/properties/properties/propertyNamesPortable lowercase record field name.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
- Local schema reference
/$defs/propertyName
/$defs/objectSchema/properties/requiredLists the entity properties that every validated materialized record must contain.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/objectSchema/properties/required/itemsPortable lowercase record field name.
- Path kind
- array item
- Purpose source
- schema description
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
- Local schema reference
/$defs/propertyName
/$defs/objectSchema/properties/typeDeclares the materialized entity record schema as an object.
- Path kind
- property
- Purpose source
- reviewed override
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/scalarType/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/scalarType/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- array
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/scalarType/oneOf/1/prefixItems/0Defines the contract shared by each ordered item in the enclosing authored list.
- Path kind
- array item
- Purpose source
- structural taxonomy
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- schema-constrained value
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/$defs/scalarType/oneOf/1/prefixItems/1Defines the contract shared by each ordered item in the enclosing authored list.
- Path kind
- array item
- Purpose source
- structural taxonomy
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- schema-constrained value
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/properties/idStable project-local identifier for the entity.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
- Local schema reference
/$defs/stableId
/properties/materializationAuthored resource, refresh, and bounded recovery-set retention applied while building entity generations.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/properties/materialization/properties/max_bytesMaximum encoded size of one generation, up to 1 GiB, as bytes or a KiB/MiB quantity.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- integer or string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/properties/materialization/properties/max_bytes/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- integer
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/properties/materialization/properties/max_bytes/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- string
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/properties/materialization/properties/max_recordsMaximum number of records allowed in one generation.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/properties/materialization/properties/refreshRefresh cadence as a canonical positive duration no greater than 30 days, or manual when an operator initiates every refresh.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/properties/materialization/properties/refresh/oneOf/0Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- schema-constrained value
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/properties/materialization/properties/refresh/oneOf/1Documents a validation alternative or condition and is not authored as a standalone configuration field.
- Path kind
- branch
- Purpose source
- structural taxonomy
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- string
- Requiredness
- conditional
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- structural
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/properties/materialization/properties/retain_generationsNumber of completed cache generations, including the active generation, retained as a bounded recovery set after successful publication. This does not make arbitrary retained generations selectable for rollback.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/properties/primary_keyField whose value uniquely identifies each materialized record.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
- Local schema reference
/$defs/stableId
/properties/revisionMonotonically increasing revision of this entity definition.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
/properties/schemaClosed JSON object schema for materialized records.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- internal
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
- Local schema reference
/$defs/objectSchema
/properties/versionEntity authoring format version.
- Path kind
- property
- Purpose source
- schema description
- Scope
- A materialized entity identity, closed record shape, governance metadata, and refresh or size constraints.
- Type
- schema-constrained value
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- authored
- Sensitivity
- public
- Owners
- entity contract; data model maintainers
- Products
- registryctl, relay, editor, docs
- Validation stages
- json schema, rust deserialization, cross file semantic, product build
- Diagnostic
registryctl.authoring.entity.invalid- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- rebuild project. Rebuild the project and review storage, disclosure, and compatibility impact when an entity contract changes.
- Example guidance
- Use a minimal synthetic entity with non-identifying field names and values from a maintained golden workspace.
- Consumers
- registryctl authoring, registry relay, editor tooling, docs generator
- Generated artifacts
- editor schemas, project build, relay config, field reference
- Review classes
- contract, privacy, relay, compatibility, documentation
Relay runtime configuration
Configuration surface: registry-relay runtime configuration. This section contains 584 documented schema paths.
(document root)Root configuration document. Parsed from YAML at startup.
- Path kind
- root
- JSON Schema pointer
(document root)- Purpose source
- schema description
- Reviewed intent profile
relay_root_structural- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- structural
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].access.aggregate_only_executionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateAccessConfig/properties/aggregate_only_execution- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].access.aggregate_only_executionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateAccessConfig/properties/aggregate_only_execution- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].access.aggregate_only_executionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateAccessConfig/properties/aggregate_only_execution- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].access.aggregate_scopeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateAccessConfig/properties/aggregate_scope- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].access.aggregate_scopeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateAccessConfig/properties/aggregate_scope- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].access.aggregate_scopeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateAccessConfig/properties/aggregate_scope- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].access.metadata_scopeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateAccessConfig/properties/metadata_scope- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].access.metadata_scopeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateAccessConfig/properties/metadata_scope- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].access.metadata_scopeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateAccessConfig/properties/metadata_scope- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].accessControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/access- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].accessControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/access- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].accessControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/access- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].allowed_filtersControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/allowed_filters- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].allowed_filtersControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/allowed_filters- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].allowed_filtersControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/allowed_filters- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].allowed_filters[]A single allowed filter: field name + permitted operators.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/allowed_filters/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AllowedFilter
datasets[].entities[].aggregates[].allowed_filters[]A single allowed filter: field name + permitted operators.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/allowed_filters/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AllowedFilter
datasets[].tables[].aggregates[].allowed_filters[]A single allowed filter: field name + permitted operators.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/allowed_filters/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AllowedFilter
datasets[].aggregates[].default_group_byControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/default_group_by- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].default_group_byControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/default_group_by- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].default_group_byControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/default_group_by- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].default_group_by[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/default_group_by/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].default_group_by[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/default_group_by/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].default_group_by[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/default_group_by/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].descriptionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/description- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].descriptionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/description- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].descriptionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/description- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].dimensionsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/dimensions- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].dimensionsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/dimensions- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].dimensionsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/dimensions- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].dimensions[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/dimensions/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateDimensionConfig
datasets[].entities[].aggregates[].dimensions[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/dimensions/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateDimensionConfig
datasets[].tables[].aggregates[].dimensions[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/dimensions/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateDimensionConfig
datasets[].aggregates[].disclosure_controlDisclosure control settings per aggregate. Defaults to
`min_group_size: 5`, `suppression: omit`.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/disclosure_control- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/DisclosureControlConfig
datasets[].entities[].aggregates[].disclosure_controlDisclosure control settings per aggregate. Defaults to
`min_group_size: 5`, `suppression: omit`.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/disclosure_control- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/DisclosureControlConfig
datasets[].tables[].aggregates[].disclosure_controlDisclosure control settings per aggregate. Defaults to
`min_group_size: 5`, `suppression: omit`.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/disclosure_control- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/DisclosureControlConfig
datasets[].aggregates[].group_byControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/group_by- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].group_byControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/group_by- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].group_byControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/group_by- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].group_by[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/group_by/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].group_by[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/group_by/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].group_by[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/group_by/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].idAggregate identifier within a resource.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/id- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateId
datasets[].entities[].aggregates[].idAggregate identifier within a resource.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/id- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateId
datasets[].tables[].aggregates[].idAggregate identifier within a resource.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/id- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateId
datasets[].aggregates[].indicatorsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/indicators- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].indicatorsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/indicators- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].indicatorsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/indicators- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].indicators[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/indicators/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateIndicatorConfig
datasets[].entities[].aggregates[].indicators[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/indicators/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateIndicatorConfig
datasets[].tables[].aggregates[].indicators[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/indicators/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateIndicatorConfig
datasets[].aggregates[].joinsLegacy entity-local aggregate fields. These stay parseable while
the public surface moves to dataset-level aggregates.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/joins- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].joinsLegacy entity-local aggregate fields. These stay parseable while
the public surface moves to dataset-level aggregates.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/joins- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].joinsLegacy entity-local aggregate fields. These stay parseable while
the public surface moves to dataset-level aggregates.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/joins- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].joins[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/joins/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateJoinConfig
datasets[].entities[].aggregates[].joins[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/joins/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateJoinConfig
datasets[].tables[].aggregates[].joins[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/joins/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateJoinConfig
datasets[].aggregates[].measuresControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/measures- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].measuresControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/measures- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].measuresControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/measures- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].measures[]One measure inside an aggregate.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/measures/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateMeasure
datasets[].entities[].aggregates[].measures[]One measure inside an aggregate.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/measures/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateMeasure
datasets[].tables[].aggregates[].measures[]One measure inside an aggregate.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/measures/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateMeasure
datasets[].aggregates[].required_filter_bindingsPrincipal-derived bindings that both satisfy the required filter gate
and are applied to the aggregate query.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/required_filter_bindings- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].required_filter_bindingsPrincipal-derived bindings that both satisfy the required filter gate
and are applied to the aggregate query.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/required_filter_bindings- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].required_filter_bindingsPrincipal-derived bindings that both satisfy the required filter gate
and are applied to the aggregate query.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/required_filter_bindings- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].required_filter_bindings[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/required_filter_bindings/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/RequiredFilterBindingConfig
datasets[].entities[].aggregates[].required_filter_bindings[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/required_filter_bindings/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/RequiredFilterBindingConfig
datasets[].tables[].aggregates[].required_filter_bindings[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/required_filter_bindings/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/RequiredFilterBindingConfig
datasets[].aggregates[].required_filtersAlternative fields or dimensions that can satisfy the aggregate gate. A
principal-bound equality filter on any listed field is sufficient, so
list multiple fields only when each is an acceptable boundary.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/required_filters- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].required_filtersAlternative fields or dimensions that can satisfy the aggregate gate. A
principal-bound equality filter on any listed field is sufficient, so
list multiple fields only when each is an acceptable boundary.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/required_filters- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].required_filtersAlternative fields or dimensions that can satisfy the aggregate gate. A
principal-bound equality filter on any listed field is sufficient, so
list multiple fields only when each is an acceptable boundary.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/required_filters- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].required_filters[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/required_filters/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].required_filters[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/required_filters/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].required_filters[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/AggregateConfig/properties/required_filters/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].source_entityControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/source_entity- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].source_entityControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/source_entity- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].source_entityControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/source_entity- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].spatialControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/spatial- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].spatialControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/spatial- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].spatialControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/spatial- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].temporal_fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/temporal_field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].temporal_fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/temporal_field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].temporal_fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/temporal_field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].titleControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/title- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].titleControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/title- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].titleControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateConfig/properties/title- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].dimensions[].codelistControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateDimensionConfig/properties/codelist- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].dimensions[].codelistControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateDimensionConfig/properties/codelist- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].dimensions[].codelistControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateDimensionConfig/properties/codelist- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].dimensions[].fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateDimensionConfig/properties/field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].dimensions[].fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateDimensionConfig/properties/field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].dimensions[].fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateDimensionConfig/properties/field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].dimensions[].idControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateDimensionConfig/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].dimensions[].idControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateDimensionConfig/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].dimensions[].idControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateDimensionConfig/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].dimensions[].labelControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateDimensionConfig/properties/label- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].dimensions[].labelControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateDimensionConfig/properties/label- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].dimensions[].labelControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateDimensionConfig/properties/label- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].indicators[].columnControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/column- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].indicators[].columnControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/column- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].indicators[].columnControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/column- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].indicators[].decimalsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/decimals- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].indicators[].decimalsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/decimals- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].indicators[].decimalsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/decimals- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].indicators[].definition_uriControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/definition_uri- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].indicators[].definition_uriControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/definition_uri- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].indicators[].definition_uriControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/definition_uri- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].indicators[].frequencyControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/frequency- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].indicators[].frequencyControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/frequency- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].indicators[].frequencyControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/frequency- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].indicators[].functionAggregate function. V1 supports the basic set plus the
optional functions (`median`, `count_distinct`, `stddev`).
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/function- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateFunction
datasets[].entities[].aggregates[].indicators[].functionAggregate function. V1 supports the basic set plus the
optional functions (`median`, `count_distinct`, `stddev`).
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/function- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateFunction
datasets[].tables[].aggregates[].indicators[].functionAggregate function. V1 supports the basic set plus the
optional functions (`median`, `count_distinct`, `stddev`).
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/function- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateFunction
datasets[].aggregates[].indicators[].idControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].indicators[].idControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].indicators[].idControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].indicators[].labelControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/label- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].indicators[].labelControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/label- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].indicators[].labelControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/label- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].indicators[].unit_measureControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/unit_measure- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].indicators[].unit_measureControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/unit_measure- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].indicators[].unit_measureControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/unit_measure- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].indicators[].unit_multControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/unit_mult- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].indicators[].unit_multControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/unit_mult- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].indicators[].unit_multControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateIndicatorConfig/properties/unit_mult- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].joins[].relationshipControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateJoinConfig/properties/relationship- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].joins[].relationshipControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateJoinConfig/properties/relationship- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].joins[].relationshipControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateJoinConfig/properties/relationship- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].measures[].columnControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateMeasure/properties/column- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].measures[].columnControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateMeasure/properties/column- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].measures[].columnControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateMeasure/properties/column- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].measures[].functionAggregate function. V1 supports the basic set plus the
optional functions (`median`, `count_distinct`, `stddev`).
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateMeasure/properties/function- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateFunction
datasets[].entities[].aggregates[].measures[].functionAggregate function. V1 supports the basic set plus the
optional functions (`median`, `count_distinct`, `stddev`).
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateMeasure/properties/function- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateFunction
datasets[].tables[].aggregates[].measures[].functionAggregate function. V1 supports the basic set plus the
optional functions (`median`, `count_distinct`, `stddev`).
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateMeasure/properties/function- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateFunction
datasets[].aggregates[].measures[].nameControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateMeasure/properties/name- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].measures[].nameControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateMeasure/properties/name- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].measures[].nameControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateMeasure/properties/name- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].spatial.bbox_fieldsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/bbox_fields- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].spatial.bbox_fieldsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/bbox_fields- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].spatial.bbox_fieldsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/bbox_fields- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].spatial.collection_idControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/collection_id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].spatial.collection_idControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/collection_id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].spatial.collection_idControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/collection_id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].spatial.dimensionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/dimension- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].spatial.dimensionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/dimension- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].spatial.dimensionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/dimension- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].spatial.geometry_entityControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/geometry_entity- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].spatial.geometry_entityControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/geometry_entity- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].spatial.geometry_entityControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/geometry_entity- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].spatial.geometry_fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/geometry_field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].spatial.geometry_fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/geometry_field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].spatial.geometry_fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/geometry_field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].spatial.geometry_id_fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/geometry_id_field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].spatial.geometry_id_fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/geometry_id_field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].spatial.geometry_id_fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/geometry_id_field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].spatial.max_geometry_verticesControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/max_geometry_vertices- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].spatial.max_geometry_verticesControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/max_geometry_vertices- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].spatial.max_geometry_verticesControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/max_geometry_vertices- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].spatial.modeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/mode- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].spatial.modeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/mode- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].spatial.modeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AggregateSpatialConfig/oneOf/0/properties/mode- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].allowed_filters[].fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AllowedFilter/properties/field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].allowed_filters[].fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AllowedFilter/properties/field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.allowed_filters[].fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AllowedFilter/properties/field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].allowed_filters[].fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AllowedFilter/properties/field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].api.allowed_filters[].fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AllowedFilter/properties/field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].allowed_filters[].opsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AllowedFilter/properties/ops- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].allowed_filters[].opsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AllowedFilter/properties/ops- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.allowed_filters[].opsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AllowedFilter/properties/ops- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].allowed_filters[].opsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AllowedFilter/properties/ops- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].api.allowed_filters[].opsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AllowedFilter/properties/ops- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].allowed_filters[].ops[]Filter operator opted into per field.
- Path kind
- array item
- JSON Schema pointer
/$defs/AllowedFilter/properties/ops/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/FilterOp
datasets[].entities[].aggregates[].allowed_filters[].ops[]Filter operator opted into per field.
- Path kind
- array item
- JSON Schema pointer
/$defs/AllowedFilter/properties/ops/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/FilterOp
datasets[].entities[].api.allowed_filters[].ops[]Filter operator opted into per field.
- Path kind
- array item
- JSON Schema pointer
/$defs/AllowedFilter/properties/ops/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/FilterOp
datasets[].tables[].aggregates[].allowed_filters[].ops[]Filter operator opted into per field.
- Path kind
- array item
- JSON Schema pointer
/$defs/AllowedFilter/properties/ops/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/FilterOp
datasets[].tables[].api.allowed_filters[].ops[]Filter operator opted into per field.
- Path kind
- array item
- JSON Schema pointer
/$defs/AllowedFilter/properties/ops/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/FilterOp
auth.api_keys[].fingerprintControls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- property
- JSON Schema pointer
/$defs/ApiKeyConfig/properties/fingerprint- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_secret_reference- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/CredentialFingerprintSchema
auth.api_keys[].idControls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- property
- JSON Schema pointer
/$defs/ApiKeyConfig/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
auth.api_keys[].scopesControls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- property
- JSON Schema pointer
/$defs/ApiKeyConfig/properties/scopes- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
auth.api_keys[].scopes[]Controls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- array item
- JSON Schema pointer
/$defs/ApiKeyConfig/properties/scopes/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
datasets[].entities[].attribute_release_profiles[].claimsClaims released on success. Non-empty; at least one `required`.
- Path kind
- property
- JSON Schema pointer
/$defs/AttributeReleaseProfile/properties/claims- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].claims[]A single released claim. Exactly one of `source_field` or `expression`
must be set: a claim is either a direct source-field projection or a
CEL-computed value.
- Path kind
- array item
- JSON Schema pointer
/$defs/AttributeReleaseProfile/properties/claims/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ReleaseClaimConfig
datasets[].entities[].attribute_release_profiles[].descriptionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AttributeReleaseProfile/properties/description- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].idProfile identifier, lower-kebab/snake (`^[a-z][a-z0-9_-]*$`). Globally
unique with `version`.
- Path kind
- property
- JSON Schema pointer
/$defs/AttributeReleaseProfile/properties/id- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].purposeData-purpose this profile is bound to. When the backing entity declares
`governed_policy.permitted_purposes`, this must be a member.
- Path kind
- property
- JSON Schema pointer
/$defs/AttributeReleaseProfile/properties/purpose- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].release_conditionsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AttributeReleaseProfile/properties/release_conditions- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].release_scopeDataset-bound scope a caller must hold to invoke this release. The
stable profile is exactly `<dataset_id>:identity_release`.
- Path kind
- property
- JSON Schema pointer
/$defs/AttributeReleaseProfile/properties/release_scope- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].responseControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AttributeReleaseProfile/properties/response- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ReleaseResponseConfig
datasets[].entities[].attribute_release_profiles[].subjectControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AttributeReleaseProfile/properties/subject- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/ReleaseSubjectConfig
datasets[].entities[].attribute_release_profiles[].titleControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/AttributeReleaseProfile/properties/title- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].versionProfile version. Globally unique with `id`; no silent "latest".
- Path kind
- property
- JSON Schema pointer
/$defs/AttributeReleaseProfile/properties/version- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
audit.sinkControls Relay audit event delivery, rotation, integrity chaining, and failure behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/AuditConfig/oneOf/0/properties/sink- Purpose source
- reviewed profile
- Reviewed intent profile
relay_audit_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
audit.pathControls Relay audit event delivery, rotation, integrity chaining, and failure behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/AuditConfig/oneOf/1/properties/path- Purpose source
- reviewed profile
- Reviewed intent profile
relay_audit_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
audit.rotateIn-process rotation for the `file` audit sink.
- Path kind
- property
- JSON Schema pointer
/$defs/AuditConfig/oneOf/1/properties/rotate- Purpose source
- schema description
- Reviewed intent profile
relay_audit_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/RotateConfig
audit.chainRetains the compatibility switch in the authored contract; Relay audit envelopes remain integrity-chained regardless of this setting.
- Path kind
- property
- JSON Schema pointer
/$defs/AuditConfig/properties/chain- Purpose source
- reviewed override
- Reviewed intent profile
relay_audit_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
audit.formatControls Relay audit event delivery, rotation, integrity chaining, and failure behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/AuditConfig/properties/format- Purpose source
- reviewed profile
- Reviewed intent profile
relay_audit_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization supplies the reviewed product-owned scalar default; its value is omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AuditFormat
audit.hash_secret_envName of the environment variable holding the per-deploy secret
used to HMAC sensitive audit values (single-record primary keys,
sensitive query parameters). Runtime startup fails closed when
this field is unset, empty, or points to a missing, empty, or
weak secret. Direct middleware tests can opt into the explicit
unkeyed dev-only hasher without using runtime config.
- Path kind
- property
- JSON Schema pointer
/$defs/AuditConfig/properties/hash_secret_env- Purpose source
- schema description
- Reviewed intent profile
relay_audit_secret_reference- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
audit.include_healthInclude `/healthz` liveness probes in the audit stream. `/ready` is
always excluded because auditing it would advance the chain after its
zero-backlog shipping check and self-invalidate the next probe.
- Path kind
- property
- JSON Schema pointer
/$defs/AuditConfig/properties/include_health- Purpose source
- schema description
- Reviewed intent profile
relay_audit_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
audit.write_policyBehavior when an audit record fails to write.
`fail_closed` (default) fails the request with a stable error code so
that no request outcome is returned without a durable audit record.
`availability_first` logs the failure and lets the request succeed for
deployments that explicitly accept best-effort audit durability.
Per-route-family selection is out of scope; this is a single
deployment-wide policy.
- Path kind
- property
- JSON Schema pointer
/$defs/AuditConfig/properties/write_policy- Purpose source
- schema description
- Reviewed intent profile
relay_audit_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AuditWritePolicySchema
consultation.audit_pseudonym_materials[]One public epoch id bound to one secret source reference.
- Path kind
- array item
- JSON Schema pointer
/$defs/AuditPseudonymMaterialCatalogConfig/items- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AuditPseudonymMaterialConfig
consultation.audit_pseudonym_materials[].key_idControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/AuditPseudonymMaterialConfig/properties/key_id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AuditPseudonymKeyIdSchema
consultation.audit_pseudonym_materials[].sourceClosed v1 set of audit-pseudonym secret source providers.
The configured name is a reference only. Secret values cannot be embedded
in this model and are loaded exactly once during runtime compilation.
- Path kind
- property
- JSON Schema pointer
/$defs/AuditPseudonymMaterialConfig/properties/source- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AuditPseudonymSecretSourceConfig
consultation.audit_pseudonym_materials[].source.namePortable environment-variable name used only as a secret reference.
Debug output is redacted even though the name is not itself key material,
preventing configuration diagnostics from disclosing secret topology.
- Path kind
- property
- JSON Schema pointer
/$defs/AuditPseudonymSecretSourceConfig/oneOf/0/properties/name- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_secret_reference- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/AuditPseudonymSecretEnvironmentName
consultation.audit_pseudonym_materials[].source.providerControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/AuditPseudonymSecretSourceConfig/oneOf/0/properties/provider- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
auth.api_keysControls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- property
- JSON Schema pointer
/$defs/AuthConfig/properties/api_keys- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
auth.api_keys[]One configured API key, identified by an id and a fingerprint reference.
The raw key never appears in config.
- Path kind
- array item
- JSON Schema pointer
/$defs/AuthConfig/properties/api_keys/items- Purpose source
- schema description
- Reviewed intent profile
relay_auth_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/ApiKeyConfig
auth.failure_throttleControls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- property
- JSON Schema pointer
/$defs/AuthConfig/properties/failure_throttle- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AuthFailureThrottleConfig
auth.modeControls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- property
- JSON Schema pointer
/$defs/AuthConfig/properties/mode- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AuthMode
auth.oidcOIDC / OAuth2 resource-server configuration. The relay validates
incoming bearer JWTs against a configured external IdP. No tokens
are minted here.
- Path kind
- property
- JSON Schema pointer
/$defs/AuthConfig/properties/oidc- Purpose source
- schema description
- Reviewed intent profile
relay_auth_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
auth.failure_throttle.enabledControls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- property
- JSON Schema pointer
/$defs/AuthFailureThrottleConfig/properties/enabled- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
auth.failure_throttle.max_failuresControls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- property
- JSON Schema pointer
/$defs/AuthFailureThrottleConfig/properties/max_failures- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
auth.failure_throttle.window_secondsControls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- property
- JSON Schema pointer
/$defs/AuthFailureThrottleConfig/properties/window_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
catalog.authority_typeBRegDCAT-AP: type IRI for the `foaf:Agent` publisher. When set, emits
`dcterms:type` on the publisher node.
BRegDCAT-AP 2.1.0 SHACL checks publisher type values against the ADMS
publishertype scheme (`http://purl.org/adms/publishertype/...`).
The relay does not enforce a vocabulary: any IRI passes through.
- Path kind
- property
- JSON Schema pointer
/$defs/CatalogConfig/properties/authority_type- Purpose source
- schema description
- Reviewed intent profile
relay_catalog_public- Scope
- Public catalog metadata emitted by Relay discovery surfaces; this intent catalog records its contract without loading deployment values.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- public
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate discovery metadata changes with the Relay deployment and review the resulting public catalog before activation.
- Example guidance
- Use synthetic public identifiers and non-routable placeholders; never copy country catalog values into generated reference documentation.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, privacy, documentation
catalog.base_urlControls Relay catalog identity and public metadata exposed for governed discovery.
- Path kind
- property
- JSON Schema pointer
/$defs/CatalogConfig/properties/base_url- Purpose source
- reviewed profile
- Reviewed intent profile
relay_catalog_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
catalog.default_spatial_coverageBRegDCAT-AP: default `dcterms:spatial` IRI applied to datasets that
do not declare their own `spatial_coverage`. Typically an EU
authority country IRI under
`http://publications.europa.eu/resource/authority/country/`.
- Path kind
- property
- JSON Schema pointer
/$defs/CatalogConfig/properties/default_spatial_coverage- Purpose source
- schema description
- Reviewed intent profile
relay_catalog_public- Scope
- Public catalog metadata emitted by Relay discovery surfaces; this intent catalog records its contract without loading deployment values.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- public
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate discovery metadata changes with the Relay deployment and review the resulting public catalog before activation.
- Example guidance
- Use synthetic public identifiers and non-routable placeholders; never copy country catalog values into generated reference documentation.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, privacy, documentation
catalog.participant_idIdentifies the participant in catalog output; when omitted, Relay derives the participant identifier from the reviewed catalog base URL.
- Path kind
- property
- JSON Schema pointer
/$defs/CatalogConfig/properties/participant_id- Purpose source
- reviewed override
- Reviewed intent profile
relay_catalog_public- Scope
- Public catalog metadata emitted by Relay discovery surfaces; this intent catalog records its contract without loading deployment values.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- public
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate discovery metadata changes with the Relay deployment and review the resulting public catalog before activation.
- Example guidance
- Use synthetic public identifiers and non-routable placeholders; never copy country catalog values into generated reference documentation.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, privacy, documentation
catalog.publisherPublishes the reviewed Relay catalog identity and descriptive metadata used for governed discovery.
- Path kind
- property
- JSON Schema pointer
/$defs/CatalogConfig/properties/publisher- Purpose source
- reviewed profile
- Reviewed intent profile
relay_catalog_public- Scope
- Public catalog metadata emitted by Relay discovery surfaces; this intent catalog records its contract without loading deployment values.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- public
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate discovery metadata changes with the Relay deployment and review the resulting public catalog before activation.
- Example guidance
- Use synthetic public identifiers and non-routable placeholders; never copy country catalog values into generated reference documentation.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, privacy, documentation
catalog.publisher_iriBRegDCAT-AP: identifier IRI for the `foaf:Agent` publisher. Use a
controlled-vocabulary corporate body IRI when publishing strict
BRegDCAT-AP.
- Path kind
- property
- JSON Schema pointer
/$defs/CatalogConfig/properties/publisher_iri- Purpose source
- schema description
- Reviewed intent profile
relay_catalog_public- Scope
- Public catalog metadata emitted by Relay discovery surfaces; this intent catalog records its contract without loading deployment values.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- public
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate discovery metadata changes with the Relay deployment and review the resulting public catalog before activation.
- Example guidance
- Use synthetic public identifiers and non-routable placeholders; never copy country catalog values into generated reference documentation.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, privacy, documentation
catalog.titlePublishes the reviewed Relay catalog identity and descriptive metadata used for governed discovery.
- Path kind
- property
- JSON Schema pointer
/$defs/CatalogConfig/properties/title- Purpose source
- reviewed profile
- Reviewed intent profile
relay_catalog_public- Scope
- Public catalog metadata emitted by Relay discovery surfaces; this intent catalog records its contract without loading deployment values.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- public
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate discovery metadata changes with the Relay deployment and review the resulting public catalog before activation.
- Example guidance
- Use synthetic public identifiers and non-routable placeholders; never copy country catalog values into generated reference documentation.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, privacy, documentation
config_trust.antirollback_state_pathControls Relay verification of signed configuration bundles, trust anchors, and rollback protection.
- Path kind
- property
- JSON Schema pointer
/$defs/ConfigTrustConfig/properties/antirollback_state_path- Purpose source
- reviewed profile
- Reviewed intent profile
relay_config_trust_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
config_trust.break_glass_override_pathControls Relay verification of signed configuration bundles, trust anchors, and rollback protection.
- Path kind
- property
- JSON Schema pointer
/$defs/ConfigTrustConfig/properties/break_glass_override_path- Purpose source
- reviewed profile
- Reviewed intent profile
relay_config_trust_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
config_trust.bundle_pathControls Relay verification of signed configuration bundles, trust anchors, and rollback protection.
- Path kind
- property
- JSON Schema pointer
/$defs/ConfigTrustConfig/properties/bundle_path- Purpose source
- reviewed profile
- Reviewed intent profile
relay_config_trust_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
config_trust.trust_anchor_pathControls Relay verification of signed configuration bundles, trust anchors, and rollback protection.
- Path kind
- property
- JSON Schema pointer
/$defs/ConfigTrustConfig/properties/trust_anchor_path- Purpose source
- reviewed profile
- Reviewed intent profile
relay_config_trust_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.artifacts.evidenceControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationArtifactClosureConfig/properties/evidence- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
consultation.artifacts.evidence[]One bounded, hash-pinned integration evidence file.
- Path kind
- array item
- JSON Schema pointer
/$defs/ConsultationArtifactClosureConfig/properties/evidence/items- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ConsultationEvidenceArtifactConfig
consultation.artifacts.integration_packsControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationArtifactClosureConfig/properties/integration_packs- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
consultation.artifacts.integration_packs[]One hash-pinned public contract or reviewed integration pack.
- Path kind
- array item
- JSON Schema pointer
/$defs/ConsultationArtifactClosureConfig/properties/integration_packs/items- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ConsultationTypedArtifactReferenceConfig
consultation.artifacts.private_bindingsControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationArtifactClosureConfig/properties/private_bindings- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
consultation.artifacts.private_bindings[]One hash-pinned public contract or reviewed integration pack.
- Path kind
- array item
- JSON Schema pointer
/$defs/ConsultationArtifactClosureConfig/properties/private_bindings/items- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ConsultationTypedArtifactReferenceConfig
consultation.artifacts.public_contractsControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationArtifactClosureConfig/properties/public_contracts- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
consultation.artifacts.public_contracts[]One hash-pinned public contract or reviewed integration pack.
- Path kind
- array item
- JSON Schema pointer
/$defs/ConsultationArtifactClosureConfig/properties/public_contracts/items- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ConsultationTypedArtifactReferenceConfig
consultation.artifacts.rhai_scriptsControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationArtifactClosureConfig/properties/rhai_scripts- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
consultation.artifacts.rhai_scripts[]One hash-pinned private binding or standalone Rhai script.
- Path kind
- array item
- JSON Schema pointer
/$defs/ConsultationArtifactClosureConfig/properties/rhai_scripts/items- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ConsultationArtifactReferenceConfig
consultation.artifacts.rhai_scripts[].pathNormalized bundle-root-relative path.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationArtifactReferenceConfig/properties/path- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.artifacts.rhai_scripts[].sha256Raw file hash recorded by Registry Config Bundle v1.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationArtifactReferenceConfig/properties/sha256- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
consultation.artifactsControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationConfig/properties/artifacts- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
consultation.audit_pseudonym_materialsBounded startup catalog of audit-pseudonym material references.
The 1..=32 bound and cross-entry uniqueness are enforced by config
validation and repeated by the material provider before loading secrets.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationConfig/properties/audit_pseudonym_materials- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AuditPseudonymMaterialCatalogConfig
consultation.authorized_workloadControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationConfig/properties/authorized_workload- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ConsultationWorkloadConfig
consultation.source_credentialsControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationConfig/properties/source_credentials- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/ConsultationSourceCredentialCatalogConfig
consultation.state_planeControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationConfig/properties/state_plane- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ConsultationStatePlaneConfig
consultation.artifacts.evidence[].classClosed evidence classes understood by consultation source-plan v1.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationEvidenceArtifactConfig/properties/class- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ConsultationEvidenceClassConfig
consultation.artifacts.evidence[].pathControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationEvidenceArtifactConfig/properties/path- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.artifacts.evidence[].sha256Controls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationEvidenceArtifactConfig/properties/sha256- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
consultation.source_credentials[]Closed V1 source-credential provider configuration.
Environment names are opaque references and are redacted from `Debug`.
There is deliberately no field capable of carrying an embedded username,
password, bearer token, or provider-specific extension.
- Path kind
- array item
- JSON Schema pointer
/$defs/ConsultationSourceCredentialCatalogConfig/items- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/ConsultationSourceCredentialConfig
consultation.source_credentials[].generationControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationSourceCredentialConfig/oneOf/0/properties/generation- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.source_credentials[].password_envPortable environment-variable name used only as a credential reference.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationSourceCredentialConfig/oneOf/0/properties/password_env- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_secret_reference- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/ConsultationCredentialEnvironmentName
consultation.source_credentials[].refExact private-binding credential reference grammar.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationSourceCredentialConfig/oneOf/0/properties/ref- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/ConsultationSourceCredentialReference
consultation.source_credentials[].typeControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationSourceCredentialConfig/oneOf/0/properties/type- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.source_credentials[].username_envPortable environment-variable name used only as a credential reference.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationSourceCredentialConfig/oneOf/0/properties/username_env- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_secret_reference- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/ConsultationCredentialEnvironmentName
consultation.source_credentials[].token_envPortable environment-variable name used only as a credential reference.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationSourceCredentialConfig/oneOf/1/properties/token_env- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_secret_reference- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/ConsultationCredentialEnvironmentName
consultation.source_credentials[].value_envPortable environment-variable name used only as a credential reference.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationSourceCredentialConfig/oneOf/2/properties/value_env- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_secret_reference- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/ConsultationCredentialEnvironmentName
consultation.source_credentials[].client_id_envPortable environment-variable name used only as a credential reference.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationSourceCredentialConfig/oneOf/4/properties/client_id_env- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_secret_reference- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/ConsultationCredentialEnvironmentName
consultation.source_credentials[].client_secret_envPortable environment-variable name used only as a credential reference.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationSourceCredentialConfig/oneOf/4/properties/client_secret_env- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_secret_reference- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/ConsultationCredentialEnvironmentName
consultation.state_plane.audit_pseudonym_keyring_lock_keyControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationStatePlaneConfig/properties/audit_pseudonym_keyring_lock_key- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.state_plane.chain_key_epoch_idControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationStatePlaneConfig/properties/chain_key_epoch_id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.state_plane.database_url_envPortable environment-variable name that resolves the state-plane URL.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationStatePlaneConfig/properties/database_url_env- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_secret_reference- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/ConsultationDatabaseUrlEnvironmentName
consultation.state_plane.root_certificate_pathControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationStatePlaneConfig/properties/root_certificate_path- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.state_plane.serving_fence_lock_keyControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationStatePlaneConfig/properties/serving_fence_lock_key- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.artifacts.integration_packs[].hashDomain-separated typed artifact hash consumed by the source-plan compiler.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationTypedArtifactReferenceConfig/properties/hash- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.artifacts.private_bindings[].hashDomain-separated typed artifact hash consumed by the source-plan compiler.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationTypedArtifactReferenceConfig/properties/hash- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.artifacts.public_contracts[].hashDomain-separated typed artifact hash consumed by the source-plan compiler.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationTypedArtifactReferenceConfig/properties/hash- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.artifacts.integration_packs[].pathNormalized bundle-root-relative path.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationTypedArtifactReferenceConfig/properties/path- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.artifacts.private_bindings[].pathNormalized bundle-root-relative path.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationTypedArtifactReferenceConfig/properties/path- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.artifacts.public_contracts[].pathNormalized bundle-root-relative path.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationTypedArtifactReferenceConfig/properties/path- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.artifacts.integration_packs[].sha256Raw file hash recorded by Registry Config Bundle v1.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationTypedArtifactReferenceConfig/properties/sha256- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
consultation.artifacts.private_bindings[].sha256Raw file hash recorded by Registry Config Bundle v1.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationTypedArtifactReferenceConfig/properties/sha256- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
consultation.artifacts.public_contracts[].sha256Raw file hash recorded by Registry Config Bundle v1.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationTypedArtifactReferenceConfig/properties/sha256- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
consultation.authorized_workload.audienceControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationWorkloadConfig/properties/audience- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.authorized_workload.client_claim_selectorClosed set of verified OAuth claims that may identify Registry Notary.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationWorkloadConfig/properties/client_claim_selector- Purpose source
- schema description
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ConsultationClientClaimSelectorConfig
consultation.authorized_workload.client_valueControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationWorkloadConfig/properties/client_value- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
consultation.authorized_workload.principal_idControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/$defs/ConsultationWorkloadConfig/properties/principal_id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
server.cors.allowed_originsControls Relay listener, transport, timeout, request-limit, and administrative endpoint behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/CorsConfig/properties/allowed_origins- Purpose source
- reviewed profile
- Reviewed intent profile
relay_server_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
server.cors.allowed_origins[]Controls Relay listener, transport, timeout, request-limit, and administrative endpoint behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/CorsConfig/properties/allowed_origins/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_server_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
auth.api_keys[].fingerprint.nameControls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialFingerprintSchema/oneOf/0/properties/name- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_secret_reference- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/RuntimeEnvironmentNameSchema
auth.api_keys[].fingerprint.providerControls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialFingerprintSchema/oneOf/0/properties/provider- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_secret_reference- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
auth.api_keys[].fingerprint.pathControls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialFingerprintSchema/oneOf/1/properties/path- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_secret_reference- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
datasets[].tables[].source.format.csv.delimiterControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/CsvFormatConfig/properties/delimiter- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].source.format.csv.header_rowControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/CsvFormatConfig/properties/header_row- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].source.format.csv.quoteControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/CsvFormatConfig/properties/quote- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].access_rightsAccess rights classification, mirrors DCAT-AP `dcterms:accessRights`.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/access_rights- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AccessRights
datasets[].aggregatesControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/aggregates- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[]Aggregate declaration: group-by columns, measures, disclosure
control.
- Path kind
- array item
- JSON Schema pointer
/$defs/DatasetConfig/properties/aggregates/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateConfig
datasets[].applicable_legislationDCAT-AP `dcatap:applicableLegislation` IRIs. This is evidence
published for standard consumers, not an application-specific
authorization or source-of-truth verdict.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/applicable_legislation- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].applicable_legislation[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/DatasetConfig/properties/applicable_legislation/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].conforms_toControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/conforms_to- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].conforms_to[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/DatasetConfig/properties/conforms_to/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].defaultsOptional table defaults for reducing repetition within one dataset.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/defaults- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/DatasetDefaultsConfig
datasets[].descriptionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/description- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entitiesControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/entities- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/DatasetConfig/properties/entities/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/EntityConfig
datasets[].idDataset identifier. Lower-snake, starts with a letter.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/id- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/DatasetId
datasets[].ownerControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/owner- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].public_servicesCPSV public services that produce this dataset. Registry Relay emits
them as standard `cpsv:PublicService` nodes; consumers decide how to
interpret that evidence.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/public_services- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].public_services[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/DatasetConfig/properties/public_services/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/PublicServiceConfig
datasets[].sensitivitySensitivity classification. Operator-defined values cover common
personal and public dataset classifications in V1.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/sensitivity- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/Sensitivity
datasets[].spatial_coverageBRegDCAT-AP: `dct:spatial` IRI for this dataset. Overrides the
catalog-level `default_spatial_coverage` when set.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/spatial_coverage- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].statusPublishes the dataset lifecycle status; when omitted, Relay emits its weakest lifecycle claim instead of inferring a stronger status.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/status- Purpose source
- reviewed override
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tablesControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/tables- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[]One private storage table under a dataset.
The public API should not expose these ids. Entity config maps one
resource into one domain resource, with optional field renaming and
relationship declarations.
- Path kind
- array item
- JSON Schema pointer
/$defs/DatasetConfig/properties/tables/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ResourceConfig
datasets[].titleControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/title- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].update_frequencyUpdate cadence; mirrors DCAT-AP `dcterms:accrualPeriodicity`. The
V1 set is the codes used by the example plus the common alternates.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetConfig/properties/update_frequency- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/UpdateFrequency
datasets[].defaults.materializationHow a configured private table is registered for query planning.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetDefaultsConfig/properties/materialization- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].defaults.refreshControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DatasetDefaultsConfig/properties/refresh- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
deployment.evidenceDeclares Relay deployment posture and reviewed waiver metadata used by operator checks.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentConfig/properties/evidence- Purpose source
- reviewed profile
- Reviewed intent profile
relay_deployment_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/DeploymentEvidenceConfig
deployment.profileDeclares Relay deployment posture and reviewed waiver metadata used by operator checks.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentConfig/properties/profile- Purpose source
- reviewed profile
- Reviewed intent profile
relay_deployment_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
deployment.waiversPer-deployment waivers. Each names one finding id, a required operator
reference, an optional summary, and a mandatory expiry date. Expired
waivers stop suppressing their finding and raise
`deployment.waiver_expired`.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentConfig/properties/waivers- Purpose source
- schema description
- Reviewed intent profile
relay_deployment_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
deployment.waivers[]One declared waiver. `expires` is an ISO 8601 `YYYY-MM-DD` date; format is
validated at load time. The reference and optional summary are validated by
the shared operations contract before either can reach posture or logs.
- Path kind
- array item
- JSON Schema pointer
/$defs/DeploymentConfig/properties/waivers/items- Purpose source
- schema description
- Reviewed intent profile
relay_deployment_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/DeploymentWaiverConfig
deployment.evidence.api_key_rotationOperator asserts an API-key rotation process is in place.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentEvidenceConfig/properties/api_key_rotation- Purpose source
- schema description
- Reviewed intent profile
relay_deployment_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
deployment.evidence.audit_ack_cursor_pathOptional path to a `registry.audit.ack_cursor.v1` file maintained by
whatever ships audit events off-host. When set, the runtime reads it to
observe shipping freshness and surfaces it as posture shipping health;
absent, shipping health stays `unverified` and only the declared
shipping target is reported.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentEvidenceConfig/properties/audit_ack_cursor_path- Purpose source
- schema description
- Reviewed intent profile
relay_deployment_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
deployment.evidence.audit_ack_max_age_secsOptional freshness window in seconds for the ack cursor's `acked_at`
timestamp. Defaults to `DEFAULT_AUDIT_ACK_MAX_AGE` (900) when unset. A
window without `audit_ack_cursor_path` is rejected at load, since a
freshness window is meaningless without a cursor to observe.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentEvidenceConfig/properties/audit_ack_max_age_secs- Purpose source
- schema description
- Reviewed intent profile
relay_deployment_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
deployment.evidence.audit_offhost_shippingOperator asserts audit records are shipped off-host (for example to a
log collector or SIEM) rather than relying solely on local retention.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentEvidenceConfig/properties/audit_offhost_shipping- Purpose source
- schema description
- Reviewed intent profile
relay_deployment_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
deployment.evidence.ingress_rate_limitOperator asserts ingress rate limiting is enforced (for example by a
gateway or reverse proxy in front of the relay).
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentEvidenceConfig/properties/ingress_rate_limit- Purpose source
- schema description
- Reviewed intent profile
relay_deployment_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
deployment.waivers[].expiresDeclares Relay deployment posture and reviewed waiver metadata used by operator checks.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentWaiverConfig/properties/expires- Purpose source
- reviewed profile
- Reviewed intent profile
relay_deployment_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
deployment.waivers[].findingDeclares Relay deployment posture and reviewed waiver metadata used by operator checks.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentWaiverConfig/properties/finding- Purpose source
- reviewed profile
- Reviewed intent profile
relay_deployment_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
deployment.waivers[].referenceDeclares Relay deployment posture and reviewed waiver metadata used by operator checks.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentWaiverConfig/properties/reference- Purpose source
- reviewed profile
- Reviewed intent profile
relay_deployment_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/DeploymentWaiverReference
deployment.waivers[].summaryStructurally valid deployment-waiver summary. Contextual authorization-value and private-key marker exclusions require semantic producer validation.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentWaiverConfig/properties/summary- Purpose source
- schema description
- Reviewed intent profile
relay_deployment_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization supplies the reviewed product-owned scalar default; its value is omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/DeploymentWaiverSummary
datasets[].aggregates[].disclosure_control.methodControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/method- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].disclosure_control.methodControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/method- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].disclosure_control.methodControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/method- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].disclosure_control.method[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/method/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].disclosure_control.method[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/method/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].disclosure_control.method[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/method/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].disclosure_control.min_cell_sizeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/min_cell_size- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].disclosure_control.min_cell_sizeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/min_cell_size- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].disclosure_control.min_cell_sizeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/min_cell_size- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].disclosure_control.min_group_sizeOptionally overrides the effective disclosure threshold for grouped results; when omitted, Relay uses the configured cell threshold.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/min_group_size- Purpose source
- reviewed override
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].disclosure_control.min_group_sizeOptionally overrides the effective disclosure threshold for grouped results; when omitted, Relay uses the configured cell threshold.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/min_group_size- Purpose source
- reviewed override
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].disclosure_control.min_group_sizeOptionally overrides the effective disclosure threshold for grouped results; when omitted, Relay uses the configured cell threshold.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/min_group_size- Purpose source
- reviewed override
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].disclosure_control.report_suppressed_rowsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/report_suppressed_rows- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].disclosure_control.report_suppressed_rowsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/report_suppressed_rows- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].disclosure_control.report_suppressed_rowsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/report_suppressed_rows- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].disclosure_control.suppressionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/suppression- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization supplies the reviewed product-owned scalar default; its value is omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/Suppression
datasets[].entities[].aggregates[].disclosure_control.suppressionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/suppression- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization supplies the reviewed product-owned scalar default; its value is omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/Suppression
datasets[].tables[].aggregates[].disclosure_control.suppressionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureControlConfig/properties/suppression- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization supplies the reviewed product-owned scalar default; its value is omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/Suppression
metadata.ecosystem_binding.idControls Relay metadata publication and registry-description behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/EcosystemBindingSelectorConfig/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_metadata_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
metadata.ecosystem_binding.versionControls Relay metadata publication and registry-description behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/EcosystemBindingSelectorConfig/properties/version- Purpose source
- reviewed profile
- Reviewed intent profile
relay_metadata_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].access.aggregate_scopeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityAccessConfig/properties/aggregate_scope- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].access.evidence_verification_scopeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityAccessConfig/properties/evidence_verification_scope- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].access.metadata_scopeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityAccessConfig/properties/metadata_scope- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].access.read_scopeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityAccessConfig/properties/read_scope- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.allowed_expansionsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityApiConfig/properties/allowed_expansions- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.allowed_expansions[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/EntityApiConfig/properties/allowed_expansions/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.allowed_filtersControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityApiConfig/properties/allowed_filters- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.allowed_filters[]A single allowed filter: field name + permitted operators.
- Path kind
- array item
- JSON Schema pointer
/$defs/EntityApiConfig/properties/allowed_filters/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AllowedFilter
datasets[].entities[].api.default_limitControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityApiConfig/properties/default_limit- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policyControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityApiConfig/properties/governed_policy- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.max_limitControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityApiConfig/properties/max_limit- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.require_purpose_headerControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityApiConfig/properties/require_purpose_header- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.required_filter_bindingsPrincipal-derived bindings that both satisfy the required filter gate
and are applied to the query.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityApiConfig/properties/required_filter_bindings- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.required_filter_bindings[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/EntityApiConfig/properties/required_filter_bindings/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/RequiredFilterBindingConfig
datasets[].entities[].api.required_filtersAlternative fields that can satisfy the row-scope gate. A
principal-bound equality filter on any listed field is sufficient, so
list multiple fields only when each is an acceptable boundary.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityApiConfig/properties/required_filters- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.required_filters[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/EntityApiConfig/properties/required_filters/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].accessControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityConfig/properties/access- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/EntityAccessConfig
datasets[].entities[].aggregatesControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityConfig/properties/aggregates- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[]Aggregate declaration: group-by columns, measures, disclosure
control.
- Path kind
- array item
- JSON Schema pointer
/$defs/EntityConfig/properties/aggregates/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateConfig
datasets[].entities[].apiControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityConfig/properties/api- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/EntityApiConfig
datasets[].entities[].attribute_release_profilesGoverned identity attribute-release profiles attached to this entity.
Each profile resolves exactly one subject and returns only the
configured, minimised claims. Empty by default (feature opt-in).
- Path kind
- property
- JSON Schema pointer
/$defs/EntityConfig/properties/attribute_release_profiles- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[]A governed identity attribute-release profile. A profile is a
projection-limited, exactly-one-subject lookup that maps a configured set of
source fields (or CEL-computed expressions) into a minimised
OIDC/UserInfo-style claim bundle. Every profile is purpose-bound and requires
a matching `data-purpose` at resolve time. Identified globally by the
`(id, version)` pair; both are required path segments at resolve time.
- Path kind
- array item
- JSON Schema pointer
/$defs/EntityConfig/properties/attribute_release_profiles/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AttributeReleaseProfile
datasets[].entities[].concept_uriControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityConfig/properties/concept_uri- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].descriptionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityConfig/properties/description- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].fieldsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityConfig/properties/fields- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].fields[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/EntityConfig/properties/fields/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/EntityFieldConfig
datasets[].entities[].nameControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityConfig/properties/name- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].relationshipsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityConfig/properties/relationships- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].relationships[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/EntityConfig/properties/relationships/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/EntityRelationshipConfig
datasets[].entities[].spatialControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityConfig/properties/spatial- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].tableResource identifier within a dataset.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityConfig/properties/table- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ResourceId
datasets[].entities[].titleControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityConfig/properties/title- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].fields[].codelistControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityFieldConfig/properties/codelist- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].fields[].concept_uriControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityFieldConfig/properties/concept_uri- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].fields[].fromControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityFieldConfig/properties/from- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].fields[].languageControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityFieldConfig/properties/language- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].fields[].nameControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityFieldConfig/properties/name- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].fields[].sensitiveControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityFieldConfig/properties/sensitive- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].fields[].unitControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityFieldConfig/properties/unit- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].relationships[].concept_uriControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityRelationshipConfig/properties/concept_uri- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].relationships[].foreign_keyControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityRelationshipConfig/properties/foreign_key- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
datasets[].entities[].relationships[].kindControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityRelationshipConfig/properties/kind- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/RelationshipKind
datasets[].entities[].relationships[].nameControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityRelationshipConfig/properties/name- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].relationships[].targetControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntityRelationshipConfig/properties/target- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.bbox_fieldsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntitySpatialConfig/properties/bbox_fields- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.collection_idControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntitySpatialConfig/properties/collection_id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.datetime_fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntitySpatialConfig/properties/datetime_field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.descriptionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntitySpatialConfig/properties/description- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.geometryControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntitySpatialConfig/properties/geometry- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/SpatialGeometryConfig
datasets[].entities[].spatial.max_bbox_degreesControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntitySpatialConfig/properties/max_bbox_degrees- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- number
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.max_geometry_verticesControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntitySpatialConfig/properties/max_geometry_vertices- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.titleControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/EntitySpatialConfig/properties/title- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].schema.fields[].codelistControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/FieldConfig/properties/codelist- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].schema.fields[].concept_uriControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/FieldConfig/properties/concept_uri- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].schema.fields[].languageControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/FieldConfig/properties/language- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].schema.fields[].nameControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/FieldConfig/properties/name- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].schema.fields[].nullableControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/FieldConfig/properties/nullable- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].schema.fields[].sensitiveControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/FieldConfig/properties/sensitive- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].schema.fields[].typePhysical type of a column. The set is fixed in V1; semantic types
are carried via `concept_uri`.
- Path kind
- property
- JSON Schema pointer
/$defs/FieldConfig/properties/type- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/FieldType
datasets[].tables[].schema.fields[].unitControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/FieldConfig/properties/unit- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.allowed_assuranceControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/GovernedPolicyConfig/properties/allowed_assurance- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.allowed_assurance[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/GovernedPolicyConfig/properties/allowed_assurance/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.max_source_age_secondsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/GovernedPolicyConfig/properties/max_source_age_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.minimum_assuranceControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/GovernedPolicyConfig/properties/minimum_assurance- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.permitted_jurisdictionsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/GovernedPolicyConfig/properties/permitted_jurisdictions- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.permitted_jurisdictions[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/GovernedPolicyConfig/properties/permitted_jurisdictions/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.permitted_purposesControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/GovernedPolicyConfig/properties/permitted_purposes- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.permitted_purposes[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/GovernedPolicyConfig/properties/permitted_purposes/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.redaction_fieldsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/GovernedPolicyConfig/properties/redaction_fields- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.redaction_fields[]Controls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- array item
- JSON Schema pointer
/$defs/GovernedPolicyConfig/properties/redaction_fields/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.require_consentControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/GovernedPolicyConfig/properties/require_consent- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.require_legal_basisControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/GovernedPolicyConfig/properties/require_legal_basis- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.trusted_contextControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/GovernedPolicyConfig/properties/trusted_context- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/GovernedTrustedContextConfig
datasets[].entities[].api.governed_policy.trusted_context.asserted_assuranceControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/GovernedTrustedContextConfig/properties/asserted_assurance- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.trusted_context.consent_refControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/GovernedTrustedContextConfig/properties/consent_ref- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.trusted_context.jurisdictionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/GovernedTrustedContextConfig/properties/jurisdiction- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.trusted_context.legal_basis_refControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/GovernedTrustedContextConfig/properties/legal_basis_ref- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.governed_policy.trusted_context.source_observed_age_secondsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/GovernedTrustedContextConfig/properties/source_observed_age_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
instance.environmentIdentifies the public Relay instance labels surfaced by posture and operations tooling.
- Path kind
- property
- JSON Schema pointer
/$defs/InstanceConfig/properties/environment- Purpose source
- reviewed profile
- Reviewed intent profile
relay_instance_public- Scope
- Public instance labels surfaced by Relay posture and operations tooling; this intent catalog records their contract without loading deployment values.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- public
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate changes to public instance identity with the Relay deployment and its operational inventory.
- Example guidance
- Use synthetic public labels; never copy a country deployment identity into generated reference documentation.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, privacy, documentation
instance.idIdentifies the public Relay instance labels surfaced by posture and operations tooling.
- Path kind
- property
- JSON Schema pointer
/$defs/InstanceConfig/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_instance_public- Scope
- Public instance labels surfaced by Relay posture and operations tooling; this intent catalog records their contract without loading deployment values.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- public
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate changes to public instance identity with the Relay deployment and its operational inventory.
- Example guidance
- Use synthetic public labels; never copy a country deployment identity into generated reference documentation.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, privacy, documentation
instance.jurisdictionIdentifies the public Relay instance labels surfaced by posture and operations tooling.
- Path kind
- property
- JSON Schema pointer
/$defs/InstanceConfig/properties/jurisdiction- Purpose source
- reviewed profile
- Reviewed intent profile
relay_instance_public- Scope
- Public instance labels surfaced by Relay posture and operations tooling; this intent catalog records their contract without loading deployment values.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- public
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate changes to public instance identity with the Relay deployment and its operational inventory.
- Example guidance
- Use synthetic public labels; never copy a country deployment identity into generated reference documentation.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, privacy, documentation
instance.ownerIdentifies the public Relay instance labels surfaced by posture and operations tooling.
- Path kind
- property
- JSON Schema pointer
/$defs/InstanceConfig/properties/owner- Purpose source
- reviewed profile
- Reviewed intent profile
relay_instance_public- Scope
- Public instance labels surfaced by Relay posture and operations tooling; this intent catalog records their contract without loading deployment values.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- public
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate changes to public instance identity with the Relay deployment and its operational inventory.
- Example guidance
- Use synthetic public labels; never copy a country deployment identity into generated reference documentation.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, privacy, documentation
metadata.ecosystem_bindingControls Relay metadata publication and registry-description behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/MetadataConfig/properties/ecosystem_binding- Purpose source
- reviewed profile
- Reviewed intent profile
relay_metadata_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
metadata.sourceControls Relay metadata publication and registry-description behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/MetadataConfig/properties/source- Purpose source
- reviewed profile
- Reviewed intent profile
relay_metadata_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/MetadataSourceConfig
metadata.source.digestControls Relay metadata publication and registry-description behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/MetadataSourceConfig/properties/digest- Purpose source
- reviewed profile
- Reviewed intent profile
relay_metadata_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
metadata.source.pathControls Relay metadata publication and registry-description behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/MetadataSourceConfig/properties/path- Purpose source
- reviewed profile
- Reviewed intent profile
relay_metadata_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
auth.oidc.allow_dev_insecure_fetch_urlsDevelopment-only escape hatch that permits loopback HTTP issuer,
discovery, and JWKS URLs. Private non-loopback networks and cloud
metadata endpoints remain denied by the platform fetch policy.
- Path kind
- property
- JSON Schema pointer
/$defs/OidcConfig/properties/allow_dev_insecure_fetch_urls- Purpose source
- schema description
- Reviewed intent profile
relay_auth_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
auth.oidc.allowed_algorithmsSignature algorithms accepted by the verifier. Defaults to
RS256, ES256, EdDSA. HS\* and `none` are intentionally absent
from [`OidcAlgorithm`].
- Path kind
- property
- JSON Schema pointer
/$defs/OidcConfig/properties/allowed_algorithms- Purpose source
- schema description
- Reviewed intent profile
relay_auth_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
auth.oidc.allowed_algorithms[]JWS signature algorithms accepted by the OIDC verifier. Symmetric
algorithms (`HS*`) and `none` are intentionally absent: shared-secret
JWTs are unsafe between a resource server and an IdP, and `none`
disables verification entirely.
YAML values are the canonical JWA `alg` strings (`RS256`, `ES256`,
`EdDSA`), case-sensitive.
- Path kind
- array item
- JSON Schema pointer
/$defs/OidcConfig/properties/allowed_algorithms/items- Purpose source
- schema description
- Reviewed intent profile
relay_auth_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/OidcAlgorithm
auth.oidc.allowed_clientsOptional allowlist of client identifiers, matched against the
token's `azp` (preferred) or `client_id` claim. Empty list
means any client is accepted.
- Path kind
- property
- JSON Schema pointer
/$defs/OidcConfig/properties/allowed_clients- Purpose source
- schema description
- Reviewed intent profile
relay_auth_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
auth.oidc.allowed_clients[]Controls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- array item
- JSON Schema pointer
/$defs/OidcConfig/properties/allowed_clients/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
auth.oidc.allowed_token_typesAccepted `typ` JOSE header values. Defaults to `JWT` and
`at+jwt` (RFC 9068). ID tokens (`id+jwt`) are not access tokens
and are rejected by default. Tokens without `typ` are rejected by
the shared verifier.
- Path kind
- property
- JSON Schema pointer
/$defs/OidcConfig/properties/allowed_token_types- Purpose source
- schema description
- Reviewed intent profile
relay_auth_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
auth.oidc.allowed_token_types[]Controls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- array item
- JSON Schema pointer
/$defs/OidcConfig/properties/allowed_token_types/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
auth.oidc.audiencesOne or more accepted `aud` values. Tokens with no `aud`, or
whose `aud` does not intersect this list, are rejected.
- Path kind
- property
- JSON Schema pointer
/$defs/OidcConfig/properties/audiences- Purpose source
- schema description
- Reviewed intent profile
relay_auth_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
auth.oidc.audiences[]Controls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- array item
- JSON Schema pointer
/$defs/OidcConfig/properties/audiences/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
auth.oidc.discovery_urlOIDC discovery document URL
(`.well-known/openid-configuration`). The JWKS URL is resolved
from `jwks_uri` in the discovered document.
- Path kind
- property
- JSON Schema pointer
/$defs/OidcConfig/properties/discovery_url- Purpose source
- schema description
- Reviewed intent profile
relay_auth_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
auth.oidc.issuerIssuer URL. Compared verbatim against the JWT `iss` claim.
- Path kind
- property
- JSON Schema pointer
/$defs/OidcConfig/properties/issuer- Purpose source
- schema description
- Reviewed intent profile
relay_auth_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
auth.oidc.jwks_cache_ttlControls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- property
- JSON Schema pointer
/$defs/OidcConfig/properties/jwks_cache_ttl- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/HumantimeDuration
auth.oidc.jwks_urlJWKS endpoint. Either this or `discovery_url` must be set.
`discovery_url` takes precedence: when both are configured the
validator rejects the document.
- Path kind
- property
- JSON Schema pointer
/$defs/OidcConfig/properties/jwks_url- Purpose source
- schema description
- Reviewed intent profile
relay_auth_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
auth.oidc.leewayControls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- property
- JSON Schema pointer
/$defs/OidcConfig/properties/leeway- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/HumantimeDuration
auth.oidc.scope_claimJWT claim whose value carries scopes. Defaults to `scope`, the
RFC 8693 / RFC 9068 space-separated form. Some IdPs use `scp`
or `permissions`; the value may be a string, an array of strings,
or an object keyed by scope name.
- Path kind
- property
- JSON Schema pointer
/$defs/OidcConfig/properties/scope_claim- Purpose source
- schema description
- Reviewed intent profile
relay_auth_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
auth.oidc.scope_mapOptional rename map: `external_scope -> internal_scope`. Applied
after parsing the scope claim, before scope-based access checks
run. Useful for adapting IdP role names (`role:foo`) to the
relay's `<dataset_id>:<level>` shape.
- Path kind
- property
- JSON Schema pointer
/$defs/OidcConfig/properties/scope_map- Purpose source
- schema description
- Reviewed intent profile
relay_auth_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
auth.oidc.scope_map.*Each reviewed key is an external token scope and each value is the bounded Relay scope mapping granted for that exact token scope.
- Path kind
- map value
- JSON Schema pointer
/$defs/OidcConfig/properties/scope_map/additionalProperties- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_oidc_scope_map_open_map- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- structural
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
auth.oidc.scope_object_required_keysKeys that must be present inside object-valued role claim values
before the role key is treated as an active scope. Object-valued
claims grant no scopes when this list is empty.
This is useful for IdPs such as Zitadel where role values are
keyed by organization id.
- Path kind
- property
- JSON Schema pointer
/$defs/OidcConfig/properties/scope_object_required_keys- Purpose source
- schema description
- Reviewed intent profile
relay_auth_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
auth.oidc.scope_object_required_keys[]Controls Relay caller authentication, authorization scopes, token verification, and abuse throttling.
- Path kind
- array item
- JSON Schema pointer
/$defs/OidcConfig/properties/scope_object_required_keys/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_auth_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
datasets[].tables[].source.table.nameControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/PostgresTableConfig/properties/name- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].source.table.schemaControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/PostgresTableConfig/properties/schema- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].public_services[].descriptionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/PublicServiceConfig/properties/description- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].public_services[].idControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/PublicServiceConfig/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].public_services[].titleControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/PublicServiceConfig/properties/title- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].defaults.refresh.intervalOne or more non-negative integer duration components separated by one ASCII space; supported units are ns, us, ms, s, m, h, d, and w
- Path kind
- property
- JSON Schema pointer
/$defs/RefreshConfig/oneOf/0/properties/interval- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- conditional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/HumantimeDuration
datasets[].tables[].refresh.intervalOne or more non-negative integer duration components separated by one ASCII space; supported units are ns, us, ms, s, m, h, d, and w
- Path kind
- property
- JSON Schema pointer
/$defs/RefreshConfig/oneOf/0/properties/interval- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- conditional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/HumantimeDuration
datasets[].defaults.refresh.modeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/RefreshConfig/oneOf/0/properties/mode- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].refresh.modeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/RefreshConfig/oneOf/0/properties/mode- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].claims[].expressionControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ReleaseClaimConfig/properties/expression- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].claims[].formatOptional value format hint.
- Path kind
- property
- JSON Schema pointer
/$defs/ReleaseClaimConfig/properties/format- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].claims[].localeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ReleaseClaimConfig/properties/locale- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].claims[].nameReleased claim name (lower-snake).
- Path kind
- property
- JSON Schema pointer
/$defs/ReleaseClaimConfig/properties/name- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].claims[].requiredWhether the claim must be present; a missing required claim denies.
- Path kind
- property
- JSON Schema pointer
/$defs/ReleaseClaimConfig/properties/required- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].claims[].sensitivityControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ReleaseClaimConfig/properties/sensitivity- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].claims[].source_fieldSource field projected into the claim. XOR with `expression`.
- Path kind
- property
- JSON Schema pointer
/$defs/ReleaseClaimConfig/properties/source_field- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].release_conditions.expressionA single CEL expression evaluated over the subject's source projection.
- Path kind
- property
- JSON Schema pointer
/$defs/ReleaseConditionsConfig/properties/expression- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ReleaseExpressionConfig
datasets[].entities[].attribute_release_profiles[].claims[].expression.celControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ReleaseExpressionConfig/properties/cel- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].release_conditions.expression.celControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ReleaseExpressionConfig/properties/cel- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].response.include_source_metadataWhether to include profile-sourced metadata in the response body.
- Path kind
- property
- JSON Schema pointer
/$defs/ReleaseResponseConfig/properties/include_source_metadata- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].attribute_release_profiles[].subject.id_typeAccepted identifier type label.
- Path kind
- property
- JSON Schema pointer
/$defs/ReleaseSubjectConfig/properties/id_type- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
datasets[].entities[].attribute_release_profiles[].subject.source_fieldSource field used to match the subject. Must be an exposed entity field.
- Path kind
- property
- JSON Schema pointer
/$defs/ReleaseSubjectConfig/properties/source_field- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
datasets[].aggregates[].required_filter_bindings[].fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/RequiredFilterBindingConfig/properties/field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].required_filter_bindings[].fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/RequiredFilterBindingConfig/properties/field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].api.required_filter_bindings[].fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/RequiredFilterBindingConfig/properties/field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].required_filter_bindings[].fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/RequiredFilterBindingConfig/properties/field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].required_filter_bindings[].sourceControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/RequiredFilterBindingConfig/properties/source- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization supplies the reviewed product-owned scalar default; its value is omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/RequiredFilterBindingSource
datasets[].entities[].aggregates[].required_filter_bindings[].sourceControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/RequiredFilterBindingConfig/properties/source- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization supplies the reviewed product-owned scalar default; its value is omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/RequiredFilterBindingSource
datasets[].entities[].api.required_filter_bindings[].sourceControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/RequiredFilterBindingConfig/properties/source- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization supplies the reviewed product-owned scalar default; its value is omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/RequiredFilterBindingSource
datasets[].tables[].aggregates[].required_filter_bindings[].sourceControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/RequiredFilterBindingConfig/properties/source- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization supplies the reviewed product-owned scalar default; its value is omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/RequiredFilterBindingSource
datasets[].tables[].access.aggregate_scopeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceAccessConfig/properties/aggregate_scope- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].access.metadata_scopeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceAccessConfig/properties/metadata_scope- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].api.allowed_filtersControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceApiConfig/properties/allowed_filters- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].api.allowed_filters[]A single allowed filter: field name + permitted operators.
- Path kind
- array item
- JSON Schema pointer
/$defs/ResourceApiConfig/properties/allowed_filters/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AllowedFilter
datasets[].tables[].api.default_limitControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceApiConfig/properties/default_limit- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].api.max_limitControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceApiConfig/properties/max_limit- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].api.require_purpose_headerControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceApiConfig/properties/require_purpose_header- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].accessResource-level scope assignments. Private tables are not exposed as row
resources in beta; row access is configured on public entities.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceConfig/properties/access- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ResourceAccessConfig
datasets[].tables[].aggregatesControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceConfig/properties/aggregates- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[]Aggregate declaration: group-by columns, measures, disclosure
control.
- Path kind
- array item
- JSON Schema pointer
/$defs/ResourceConfig/properties/aggregates/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AggregateConfig
datasets[].tables[].apiResource-level API knobs: per-field filter allowlist, limit caps,
and the `Data-Purpose` requirement.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceConfig/properties/api- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ResourceApiConfig
datasets[].tables[].idResource identifier within a dataset.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceConfig/properties/id- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ResourceId
datasets[].tables[].materializationHow a configured private table is registered for query planning.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceConfig/properties/materialization- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].primary_keyControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceConfig/properties/primary_key- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
datasets[].tables[].refreshControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceConfig/properties/refresh- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].schemaDeclared resource schema. `strict` is the spec's `strict_schema`
flag; on mismatch ingestion refuses to register the resource.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceConfig/properties/schema- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/SchemaConfig
datasets[].tables[].sourceSource plugin selection. Tagged on `type:` so HTTP, S3, or additional
database variants can land additively later.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceConfig/properties/source- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/SourceConfig
datasets[].tables[].source.format.csvControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceFormatConfig/properties/csv- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].source.format.parquetControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceFormatConfig/properties/parquet- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].source.format.xlsxControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/ResourceFormatConfig/properties/xlsx- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
audit.rotate.max_filesControls Relay audit event delivery, rotation, integrity chaining, and failure behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/RotateConfig/properties/max_files- Purpose source
- reviewed profile
- Reviewed intent profile
relay_audit_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
audit.rotate.max_size_mbControls Relay audit event delivery, rotation, integrity chaining, and failure behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/RotateConfig/properties/max_size_mb- Purpose source
- reviewed profile
- Reviewed intent profile
relay_audit_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].schema.fieldsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SchemaConfig/properties/fields- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].schema.fields[]One column in a resource schema. Physical type and optional
semantic annotations used by catalog and schema metadata.
- Path kind
- array item
- JSON Schema pointer
/$defs/SchemaConfig/properties/fields/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/FieldConfig
datasets[].tables[].schema.strictControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SchemaConfig/properties/strict- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
server.admin_bindCanonical dotted-decimal IPv4 or bracketed IPv6 plus a decimal port from 0 through 65535
- Path kind
- property
- JSON Schema pointer
/$defs/ServerConfig/properties/admin_bind- Purpose source
- schema description
- Reviewed intent profile
relay_server_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
server.bindCanonical dotted-decimal IPv4 or bracketed IPv6 plus a decimal port from 0 through 65535
- Path kind
- property
- JSON Schema pointer
/$defs/ServerConfig/properties/bind- Purpose source
- schema description
- Reviewed intent profile
relay_server_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/SocketAddr
server.cache_dirControls Relay listener, transport, timeout, request-limit, and administrative endpoint behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/ServerConfig/properties/cache_dir- Purpose source
- reviewed profile
- Reviewed intent profile
relay_server_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
server.corsCORS allowlist; default-deny per Section 17 item 7.
- Path kind
- property
- JSON Schema pointer
/$defs/ServerConfig/properties/cors- Purpose source
- schema description
- Reviewed intent profile
relay_server_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/CorsConfig
server.http1_header_read_timeoutOne or more non-negative integer duration components separated by one ASCII space; supported units are ns, us, ms, s, m, h, d, and w
- Path kind
- property
- JSON Schema pointer
/$defs/ServerConfig/properties/http1_header_read_timeout- Purpose source
- schema description
- Reviewed intent profile
relay_server_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/HumantimeDuration
server.max_connectionsControls Relay listener, transport, timeout, request-limit, and administrative endpoint behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/ServerConfig/properties/max_connections- Purpose source
- reviewed profile
- Reviewed intent profile
relay_server_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
server.max_source_file_bytesControls Relay listener, transport, timeout, request-limit, and administrative endpoint behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/ServerConfig/properties/max_source_file_bytes- Purpose source
- reviewed profile
- Reviewed intent profile
relay_server_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
server.openapi_requires_authKeeps the configured OpenAPI document behind Relay authentication unless an operator explicitly accepts unauthenticated contract discovery.
- Path kind
- property
- JSON Schema pointer
/$defs/ServerConfig/properties/openapi_requires_auth- Purpose source
- reviewed override
- Reviewed intent profile
relay_server_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
server.request_body_timeoutOne or more non-negative integer duration components separated by one ASCII space; supported units are ns, us, ms, s, m, h, d, and w
- Path kind
- property
- JSON Schema pointer
/$defs/ServerConfig/properties/request_body_timeout- Purpose source
- schema description
- Reviewed intent profile
relay_server_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/HumantimeDuration
server.request_timeoutOne or more non-negative integer duration components separated by one ASCII space; supported units are ns, us, ms, s, m, h, d, and w
- Path kind
- property
- JSON Schema pointer
/$defs/ServerConfig/properties/request_timeout- Purpose source
- schema description
- Reviewed intent profile
relay_server_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/HumantimeDuration
server.trust_proxy`X-Forwarded-For` policy. Until the `ipnet` crate lands in deps we
keep CIDR specs as strings and validate format in
[`validate::run`].
- Path kind
- property
- JSON Schema pointer
/$defs/ServerConfig/properties/trust_proxy- Purpose source
- schema description
- Reviewed intent profile
relay_server_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/TrustProxyConfig
server.xlsx_max_file_bytesControls Relay listener, transport, timeout, request-limit, and administrative endpoint behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/ServerConfig/properties/xlsx_max_file_bytes- Purpose source
- reviewed profile
- Reviewed intent profile
relay_server_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].source.formatStorage table format override. If omitted, ingest infers the format
from the source file extension.
- Path kind
- property
- JSON Schema pointer
/$defs/SourceConfig/oneOf/0/properties/format- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].source.pathControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SourceConfig/oneOf/0/properties/path- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
datasets[].tables[].source.typeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SourceConfig/oneOf/0/properties/type- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].source.change_token_sqlControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SourceConfig/oneOf/1/properties/change_token_sql- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
datasets[].tables[].source.connect_timeoutOne or more non-negative integer duration components separated by one ASCII space; supported units are ns, us, ms, s, m, h, d, and w
- Path kind
- property
- JSON Schema pointer
/$defs/SourceConfig/oneOf/1/properties/connect_timeout- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/HumantimeDuration
datasets[].tables[].source.connection_envControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SourceConfig/oneOf/1/properties/connection_env- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_secret_reference- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
- Local schema reference
/$defs/PostgresEnvironmentNameSchema
datasets[].tables[].source.queryControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SourceConfig/oneOf/1/properties/query- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].source.query_timeoutOne or more non-negative integer duration components separated by one ASCII space; supported units are ns, us, ms, s, m, h, d, and w
- Path kind
- property
- JSON Schema pointer
/$defs/SourceConfig/oneOf/1/properties/query_timeout- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/HumantimeDuration
datasets[].tables[].source.tableStructured database table reference. Keeping schema/name separate
avoids parsing dotted identifiers and leaves quoting to connectors.
- Path kind
- property
- JSON Schema pointer
/$defs/SourceConfig/oneOf/1/properties/table- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].spatial.bbox_fields.max_xControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/max_x- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].spatial.bbox_fields.max_xControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/max_x- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.bbox_fields.max_xControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/max_x- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].spatial.bbox_fields.max_xControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/max_x- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].spatial.bbox_fields.max_yControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/max_y- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].spatial.bbox_fields.max_yControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/max_y- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.bbox_fields.max_yControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/max_y- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].spatial.bbox_fields.max_yControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/max_y- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].spatial.bbox_fields.min_xControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/min_x- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].spatial.bbox_fields.min_xControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/min_x- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.bbox_fields.min_xControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/min_x- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].spatial.bbox_fields.min_xControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/min_x- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].aggregates[].spatial.bbox_fields.min_yControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/min_y- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].aggregates[].spatial.bbox_fields.min_yControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/min_y- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.bbox_fields.min_yControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/min_y- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].aggregates[].spatial.bbox_fields.min_yControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialBboxFieldsConfig/properties/min_y- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.geometry.crsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialGeometryConfig/oneOf/0/properties/crs- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.geometry.kindControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialGeometryConfig/oneOf/0/properties/kind- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.geometry.latitude_fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialGeometryConfig/oneOf/0/properties/latitude_field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.geometry.longitude_fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialGeometryConfig/oneOf/0/properties/longitude_field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].entities[].spatial.geometry.fieldControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/SpatialGeometryConfig/oneOf/1/properties/field- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.disability_registry.datasetDataset identifier. Lower-snake, starts with a letter.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciDisabilityRegistryConfig/properties/dataset- Purpose source
- schema description
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/DatasetId
standards.spdci.disability_registry.disabled_positive_valuesCase-insensitive values interpreted as disabled.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciDisabilityRegistryConfig/properties/disabled_positive_values- Purpose source
- schema description
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.disability_registry.disabled_positive_values[]Controls Relay standards-specific APIs, protocol mappings, and bounded interoperability behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SpdciDisabilityRegistryConfig/properties/disabled_positive_values/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.disability_registry.disabled_status_fieldEntity field whose value determines the SP DCI disabled response.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciDisabilityRegistryConfig/properties/disabled_status_field- Purpose source
- schema description
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.disability_registry.entityControls Relay standards-specific APIs, protocol mappings, and bounded interoperability behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciDisabilityRegistryConfig/properties/entity- Purpose source
- reviewed profile
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.disability_registry.query_fieldEntity field filtered when the SP DCI query key is present.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciDisabilityRegistryConfig/properties/query_field- Purpose source
- schema description
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.disability_registry.query_keyQuery key accepted from SP DCI `disabled_criteria.query`.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciDisabilityRegistryConfig/properties/query_key- Purpose source
- schema description
- Reviewed intent profile
relay_standards_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
standards.spdci.registries.*.datasetDataset identifier. Lower-snake, starts with a letter.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciRegistryConfig/properties/dataset- Purpose source
- schema description
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/DatasetId
standards.spdci.registries.*.default_limitControls Relay standards-specific APIs, protocol mappings, and bounded interoperability behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciRegistryConfig/properties/default_limit- Purpose source
- reviewed profile
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.registries.*.entityControls Relay standards-specific APIs, protocol mappings, and bounded interoperability behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciRegistryConfig/properties/entity- Purpose source
- reviewed profile
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.registries.*.expression_fieldsDCI expression or predicate attribute to entity field mappings.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciRegistryConfig/properties/expression_fields- Purpose source
- schema description
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.registries.*.expression_fields.*Each reviewed key names an expression-visible field and each value defines the bounded source expression exposed under that name.
- Path kind
- map value
- JSON Schema pointer
/$defs/SpdciRegistryConfig/properties/expression_fields/additionalProperties- Purpose source
- reviewed profile
- Reviewed intent profile
relay_standards_spdci_registries_expression_fields_open_map- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- structural
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.registries.*.identifiersDCI identifier type to entity field mappings for `idtype-value`.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciRegistryConfig/properties/identifiers- Purpose source
- schema description
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.registries.*.identifiers.*Each reviewed key names an identifier role and each value defines the exact request identifier binding for that role.
- Path kind
- map value
- JSON Schema pointer
/$defs/SpdciRegistryConfig/properties/identifiers/additionalProperties- Purpose source
- reviewed profile
- Reviewed intent profile
relay_standards_spdci_registries_identifiers_open_map- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- structural
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.registries.*.record_typeControls Relay standards-specific APIs, protocol mappings, and bounded interoperability behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciRegistryConfig/properties/record_type- Purpose source
- reviewed profile
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.registries.*.registry_typeControls Relay standards-specific APIs, protocol mappings, and bounded interoperability behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciRegistryConfig/properties/registry_type- Purpose source
- reviewed profile
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.registries.*.response_fieldsSP DCI output path to entity field mappings for direct response
projection. A CEL mapping takes precedence when both are set.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciRegistryConfig/properties/response_fields- Purpose source
- schema description
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.registries.*.response_fields.*Each reviewed key names a response field and each value defines the exact bounded response projection for that field.
- Path kind
- map value
- JSON Schema pointer
/$defs/SpdciRegistryConfig/properties/response_fields/additionalProperties- Purpose source
- reviewed profile
- Reviewed intent profile
relay_standards_spdci_registries_response_fields_open_map- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- structural
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.registries.*.response_mapping_pathOptional local CEL mapping document used to shape response records.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciRegistryConfig/properties/response_mapping_path- Purpose source
- schema description
- Reviewed intent profile
relay_standards_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
standards.spdci.registries.*.response_schema_pathOptional local JSON Schema used to validate shaped response records.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciRegistryConfig/properties/response_schema_path- Purpose source
- schema description
- Reviewed intent profile
relay_standards_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
standards.spdci.disability_registryRuntime binding from SP DCI Disability Registry sync APIs to one
configured Registry Relay entity.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciStandardsConfig/properties/disability_registry- Purpose source
- schema description
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.registriesControls Relay standards-specific APIs, protocol mappings, and bounded interoperability behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SpdciStandardsConfig/properties/registries- Purpose source
- reviewed profile
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
standards.spdci.registries.*Runtime binding from a DCI registry sync search API to one configured
Registry Relay entity.
- Path kind
- map value
- JSON Schema pointer
/$defs/SpdciStandardsConfig/properties/registries/additionalProperties- Purpose source
- schema description
- Reviewed intent profile
relay_standards_spdci_registries_open_map- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- structural
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/SpdciRegistryConfig
standards.spdciSocial Protection Digital Convergence Initiative (SP DCI) adapter
configuration.
- Path kind
- property
- JSON Schema pointer
/$defs/StandardsConfig/properties/spdci- Purpose source
- schema description
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
server.trust_proxy.enabledControls Relay listener, transport, timeout, request-limit, and administrative endpoint behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/TrustProxyConfig/properties/enabled- Purpose source
- reviewed profile
- Reviewed intent profile
relay_server_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
server.trust_proxy.trusted_proxiesControls Relay listener, transport, timeout, request-limit, and administrative endpoint behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/TrustProxyConfig/properties/trusted_proxies- Purpose source
- reviewed profile
- Reviewed intent profile
relay_server_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
server.trust_proxy.trusted_proxies[]Controls Relay listener, transport, timeout, request-limit, and administrative endpoint behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/TrustProxyConfig/properties/trusted_proxies/items- Purpose source
- reviewed profile
- Reviewed intent profile
relay_server_sensitive- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, security, privacy, documentation
datasets[].tables[].source.format.xlsx.data_rangeControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/XlsxFormatConfig/properties/data_range- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].source.format.xlsx.header_rowControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/XlsxFormatConfig/properties/header_row- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[].tables[].source.format.xlsx.sheetControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/$defs/XlsxFormatConfig/properties/sheet- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
auditAudit configuration. Sink choice gates further fields via the
tagged `AuditSinkConfig` enum. The enum is flattened onto the
containing struct so that the YAML `sink:` key acts as the
discriminator, matching the public example configuration.
`deny_unknown_fields` is deliberately omitted here: `serde` does
not support combining it with `#[serde(flatten)]` on an internally
tagged enum (unknown keys in `audit` are caught by the enum's own
`deny_unknown_fields`).
- Path kind
- property
- JSON Schema pointer
/properties/audit- Purpose source
- schema description
- Reviewed intent profile
relay_audit_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AuditConfig
authAuthentication configuration. Exactly one of `api_keys` and `oidc`
is consumed at startup, gated by `mode`; cross-field validation in
[`validate`] enforces that only the active block is populated.
- Path kind
- property
- JSON Schema pointer
/properties/auth- Purpose source
- schema description
- Reviewed intent profile
relay_auth_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/AuthConfig
catalogCatalog-level metadata surfaced by `/metadata/*` and DCAT outputs.
- Path kind
- property
- JSON Schema pointer
/properties/catalog- Purpose source
- schema description
- Reviewed intent profile
relay_catalog_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/CatalogConfig
config_trustOptional signed configuration bundle trust state.
Simple local deployments omit this block. Bundle-aware deployments pin the
local trust anchor, bundle, and anti-rollback state paths explicitly.
- Path kind
- property
- JSON Schema pointer
/properties/config_trust- Purpose source
- schema description
- Reviewed intent profile
relay_config_trust_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
consultationControls governed consultation execution, reviewed artifacts, credentials, and result handling.
- Path kind
- property
- JSON Schema pointer
/properties/consultation- Purpose source
- reviewed profile
- Reviewed intent profile
relay_consultation_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasetsControls Relay dataset, entity, aggregate, source, refresh, disclosure, and access contracts.
- Path kind
- property
- JSON Schema pointer
/properties/datasets- Purpose source
- reviewed profile
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
datasets[]A single dataset declaration.
- Path kind
- array item
- JSON Schema pointer
/properties/datasets/items- Purpose source
- schema description
- Reviewed intent profile
relay_datasets_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/DatasetConfig
deploymentDeclares Relay deployment posture and reviewed waiver metadata used by operator checks.
- Path kind
- property
- JSON Schema pointer
/properties/deployment- Purpose source
- reviewed profile
- Reviewed intent profile
relay_deployment_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/DeploymentConfig
instanceStable deployment identity surfaced in redacted operations posture.
- Path kind
- property
- JSON Schema pointer
/properties/instance- Purpose source
- schema description
- Reviewed intent profile
relay_instance_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/InstanceConfig
metadataOptional split metadata manifest loaded alongside the runtime config.
- Path kind
- property
- JSON Schema pointer
/properties/metadata- Purpose source
- schema description
- Reviewed intent profile
relay_metadata_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
serverHTTP listener and adjacent server-wide knobs.
- Path kind
- property
- JSON Schema pointer
/properties/server- Purpose source
- schema description
- Reviewed intent profile
relay_server_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/ServerConfig
standardsControls Relay standards-specific APIs, protocol mappings, and bounded interoperability behavior.
- Path kind
- property
- JSON Schema pointer
/properties/standards- Purpose source
- reviewed profile
- Reviewed intent profile
relay_standards_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
- Local schema reference
/$defs/StandardsConfig
vocabulariesControls the reviewed vocabulary bindings Relay uses to interpret namespaced terms.
- Path kind
- property
- JSON Schema pointer
/properties/vocabularies- Purpose source
- reviewed profile
- Reviewed intent profile
relay_vocabularies_internal- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
vocabularies.*Each reviewed key is a vocabulary prefix and each value binds that prefix to its operator-approved vocabulary identifier.
- Path kind
- map value
- JSON Schema pointer
/properties/vocabularies/additionalProperties- Purpose source
- reviewed profile
- Reviewed intent profile
relay_vocabularies_open_map- Scope
- The complete product-owned Relay runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- structural
- Owners
- relay runtime; relay maintainers
- Products
- relay, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
config.validation_error- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Relay deployment and rollback review before activating changes to runtime bindings, trust, access, or data-serving behavior.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry relay, docs generator
- Generated artifacts
- relay config, field reference
- Review classes
- contract, relay, documentation
Notary runtime configuration
Configuration surface: registry-notary runtime configuration. This section contains 530 documented schema paths.
(document root)Defines the complete Notary runtime configuration boundary consumed when a Notary instance starts.
- Path kind
- root
- JSON Schema pointer
(document root)- Purpose source
- reviewed profile
- Reviewed intent profile
notary_root_structural- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- not applicable
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- structural
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
auth.access_token_signing.access_token_ttl_secondsAccess-token lifetime in seconds.
- Path kind
- property
- JSON Schema pointer
/$defs/AccessTokenSigningConfig/properties/access_token_ttl_seconds- Purpose source
- schema description
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.access_token_signing.allowed_algorithmsAllowed signing algorithms. Only EdDSA is supported.
- Path kind
- property
- JSON Schema pointer
/$defs/AccessTokenSigningConfig/properties/allowed_algorithms- Purpose source
- schema description
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.access_token_signing.allowed_algorithms[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/AccessTokenSigningConfig/properties/allowed_algorithms/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.access_token_signing.audiencesAudiences (`aud`) accepted for Notary-minted access tokens.
- Path kind
- property
- JSON Schema pointer
/$defs/AccessTokenSigningConfig/properties/audiences- Purpose source
- schema description
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.access_token_signing.audiences[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/AccessTokenSigningConfig/properties/audiences/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.access_token_signing.enabledControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/AccessTokenSigningConfig/properties/enabled- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.access_token_signing.issuerIssuer (`iss`) the Notary stamps into its own access tokens.
- Path kind
- property
- JSON Schema pointer
/$defs/AccessTokenSigningConfig/properties/issuer- Purpose source
- schema description
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.access_token_signing.signing_key_id`evidence.signing_keys` entry used to sign access tokens. Must be a
dedicated key, never a credential-signing key.
- Path kind
- property
- JSON Schema pointer
/$defs/AccessTokenSigningConfig/properties/signing_key_id- Purpose source
- schema description
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.access_token_signing.token_typHeader `typ` stamped into Notary access tokens, distinct from the
credential `typ` so a token cannot be replayed as another class.
- Path kind
- property
- JSON Schema pointer
/$defs/AccessTokenSigningConfig/properties/token_typ- Purpose source
- schema description
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.access_token_signing.verification_key_idsAdditional publish-only `evidence.signing_keys` entries accepted for
verifying previously minted Notary access tokens and pre-authorized
codes during a governed key rotation.
- Path kind
- property
- JSON Schema pointer
/$defs/AccessTokenSigningConfig/properties/verification_key_ids- Purpose source
- schema description
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.access_token_signing.verification_key_ids[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/AccessTokenSigningConfig/properties/verification_key_ids/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.claims[].operations.batch_evaluate.enabledControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/BatchOperationConfig/properties/enabled- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].operations.batch_evaluate.max_subjectsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/BatchOperationConfig/properties/max_subjects- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.claims[].cccev.evidence_typeControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/CccevConfig/properties/evidence_type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].cccev.evidence_type_iriControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/CccevConfig/properties/evidence_type_iri- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].cccev.requirement_typeControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/CccevConfig/properties/requirement_type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].rule.bindings.claimsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/CelBindingsConfig/properties/claims- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].rule.bindings.claims.*Each reviewed key names a CEL claim binding and each value selects the approved evidence claim exposed to that binding.
- Path kind
- map value
- JSON Schema pointer
/$defs/CelBindingsConfig/properties/claims/additionalProperties- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_claims_rule_bindings_claims_open_map- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- structural
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/ClaimBindingConfig
evidence.claims[].rule.bindings.varsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/CelBindingsConfig/properties/vars- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].rule.bindings.claims.*.binding_typeControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimBindingConfig/properties/binding_type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].rule.bindings.claims.*.claimControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimBindingConfig/properties/claim- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].cccevControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/cccev- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].credential_profilesControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/credential_profiles- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.claims[].credential_profiles[]Controls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- array item
- JSON Schema pointer
/$defs/ClaimDefinition/properties/credential_profiles/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.claims[].depends_onControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/depends_on- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].depends_on[]Controls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- array item
- JSON Schema pointer
/$defs/ClaimDefinition/properties/depends_on/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].disclosureControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/disclosure- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/DisclosureConfig
evidence.claims[].evidence_modeControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/evidence_mode- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/ClaimEvidenceMode
evidence.claims[].formatsOmitting this field keeps existing authored claims renderable using the
canonical claim-result representation. An explicitly empty list is
rejected during configuration validation.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/formats- Purpose source
- schema description
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].formats[]Controls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- array item
- JSON Schema pointer
/$defs/ClaimDefinition/properties/formats/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].idControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].inputsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/inputs- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].inputs[]Controls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- array item
- JSON Schema pointer
/$defs/ClaimDefinition/properties/inputs/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/ClaimInputConfig
evidence.claims[].ootsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/oots- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].operationsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/operations- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/ClaimOperationsConfig
evidence.claims[].purposeControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/purpose- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].required_scopesCaller scopes checked before any registry consultation is dispatched.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/required_scopes- Purpose source
- schema description
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].required_scopes[]Controls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- array item
- JSON Schema pointer
/$defs/ClaimDefinition/properties/required_scopes/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].ruleControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/rule- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/RuleConfig
evidence.claims[].semanticsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/semantics- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].subject_typeControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/subject_type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.claims[].titleControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/title- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].valueControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/value- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/ClaimValueConfig
evidence.claims[].versionControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimDefinition/properties/version- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].inputs[].nameControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimInputConfig/properties/name- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].inputs[].typeControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimInputConfig/properties/type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].operations.batch_evaluateControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimOperationsConfig/properties/batch_evaluate- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/BatchOperationConfig
evidence.claims[].operations.evaluateControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimOperationsConfig/properties/evaluate- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/OperationConfig
auth.api_keys[].authorization_details.claims[].idControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimRefObject/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.claims[].idControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimRefObject/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.claims[].versionControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimRefObject/properties/version- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.claims[].versionControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimRefObject/properties/version- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.claims[].semantics.conceptControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimSemanticConfig/properties/concept- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].semantics.derived_fromControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimSemanticConfig/properties/derived_from- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].semantics.derived_from[]Controls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- array item
- JSON Schema pointer
/$defs/ClaimSemanticConfig/properties/derived_from/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].semantics.predicateControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimSemanticConfig/properties/predicate- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].semantics.propertyControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimSemanticConfig/properties/property- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].semantics.value_mappingControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimSemanticConfig/properties/value_mapping- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].semantics.vocabularyControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimSemanticConfig/properties/vocabulary- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].value.max_bytesControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimValueConfig/properties/max_bytes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a per-claim string byte ceiling.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].value.nullableControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimValueConfig/properties/nullable- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the reviewed product-owned scalar default; its value is omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].value.typeControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimValueConfig/properties/type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].value.unitControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ClaimValueConfig/properties/unit- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.concurrency.subjectsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/ConcurrencyConfig/properties/subjects- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
config_trust.antirollback_state_pathControls Notary verification of signed configuration bundles, trust anchors, and rollback protection.
- Path kind
- property
- JSON Schema pointer
/$defs/ConfigTrustConfig/properties/antirollback_state_path- Purpose source
- reviewed profile
- Reviewed intent profile
notary_config_trust_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
config_trust.break_glass_override_pathControls Notary verification of signed configuration bundles, trust anchors, and rollback protection.
- Path kind
- property
- JSON Schema pointer
/$defs/ConfigTrustConfig/properties/break_glass_override_path- Purpose source
- reviewed profile
- Reviewed intent profile
notary_config_trust_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
config_trust.bundle_pathControls Notary verification of signed configuration bundles, trust anchors, and rollback protection.
- Path kind
- property
- JSON Schema pointer
/$defs/ConfigTrustConfig/properties/bundle_path- Purpose source
- reviewed profile
- Reviewed intent profile
notary_config_trust_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
config_trust.trust_anchor_pathControls Notary verification of signed configuration bundles, trust anchors, and rollback protection.
- Path kind
- property
- JSON Schema pointer
/$defs/ConfigTrustConfig/properties/trust_anchor_path- Purpose source
- reviewed profile
- Reviewed intent profile
notary_config_trust_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.credential_profiles.*.disclosure.allowedControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialDisclosureConfig/properties/allowed- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.credential_profiles.*.disclosure.allowed[]Controls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- array item
- JSON Schema pointer
/$defs/CredentialDisclosureConfig/properties/allowed/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].fingerprint.nameControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialFingerprintRef/properties/name- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_secret_reference- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].fingerprint.nameControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialFingerprintRef/properties/name- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_secret_reference- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].fingerprint.pathControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialFingerprintRef/properties/path- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_secret_reference- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].fingerprint.pathControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialFingerprintRef/properties/path- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_secret_reference- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].fingerprint.providerControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialFingerprintRef/properties/provider- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].fingerprint.providerControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialFingerprintRef/properties/provider- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.credential_profiles.*.allowed_claimsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialProfileConfig/properties/allowed_claims- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.credential_profiles.*.allowed_claims[]Controls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- array item
- JSON Schema pointer
/$defs/CredentialProfileConfig/properties/allowed_claims/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.credential_profiles.*.disclosureControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialProfileConfig/properties/disclosure- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/CredentialDisclosureConfig
evidence.credential_profiles.*.formatControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialProfileConfig/properties/format- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.credential_profiles.*.holder_bindingControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialProfileConfig/properties/holder_binding- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/HolderBindingConfig
evidence.credential_profiles.*.issuerControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialProfileConfig/properties/issuer- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.credential_profiles.*.signing_keyControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialProfileConfig/properties/signing_key- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.credential_profiles.*.validity_secondsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialProfileConfig/properties/validity_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.credential_profiles.*.vctControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialProfileConfig/properties/vct- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
credential_status.base_urlControls Notary credential-status publication and retention behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialStatusConfig/properties/base_url- Purpose source
- reviewed profile
- Reviewed intent profile
notary_credential_status_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
credential_status.enabledControls Notary credential-status publication and retention behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialStatusConfig/properties/enabled- Purpose source
- reviewed profile
- Reviewed intent profile
notary_credential_status_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
credential_status.retention_secondsControls Notary credential-status publication and retention behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/CredentialStatusConfig/properties/retention_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
notary_credential_status_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
deployment.evidenceDeclares Notary deployment posture and reviewed waiver metadata used by operator checks.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentConfig/properties/evidence- Purpose source
- reviewed profile
- Reviewed intent profile
notary_deployment_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/DeploymentEvidenceConfig
deployment.multi_instanceDeclares Notary deployment posture and reviewed waiver metadata used by operator checks.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentConfig/properties/multi_instance- Purpose source
- reviewed profile
- Reviewed intent profile
notary_deployment_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
deployment.profileThe set of deployment profiles an operator can declare.
Frozen at introduction; new profiles may be added but existing ones never
change meaning. Deserialization is strict: an unknown profile string fails,
which surfaces as a startup error.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentConfig/properties/profile- Purpose source
- schema description
- Reviewed intent profile
notary_deployment_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
deployment.waiversDeclares Notary deployment posture and reviewed waiver metadata used by operator checks.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentConfig/properties/waivers- Purpose source
- reviewed profile
- Reviewed intent profile
notary_deployment_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
deployment.waivers[]One operator-configured waiver.
A waiver names exactly one finding id, a required operator reference, an
optional summary, and a mandatory expiry date (`YYYY-MM-DD`). The shared
operations contract validates metadata before it can reach posture or logs.
- Path kind
- array item
- JSON Schema pointer
/$defs/DeploymentConfig/properties/waivers/items- Purpose source
- schema description
- Reviewed intent profile
notary_deployment_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/DeploymentWaiverConfig
deployment.evidence.audit_ack_cursor_pathOptional path to a `registry.audit.ack_cursor.v1` file maintained by
whatever ships audit events off-host. Runtime health requires both a
fresh timestamp and a watermark equal to the live keyed audit-chain tail.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentEvidenceConfig/properties/audit_ack_cursor_path- Purpose source
- schema description
- Reviewed intent profile
notary_deployment_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
deployment.evidence.audit_ack_max_age_secsOptional freshness window, in seconds, for the off-host ack cursor.
Unset defaults to [`DEFAULT_AUDIT_ACK_MAX_AGE`] (900s). Meaningless
without `audit_ack_cursor_path`; config load rejects that combination.
[`DEFAULT_AUDIT_ACK_MAX_AGE`]: registry_platform_ops::DEFAULT_AUDIT_ACK_MAX_AGE
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentEvidenceConfig/properties/audit_ack_max_age_secs- Purpose source
- schema description
- Reviewed intent profile
notary_deployment_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
deployment.evidence.audit_offhost_shippingOperator asserts audit log events are shipped off-host (for example to
a log aggregator or SIEM) so a local file sink does not cap retention.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentEvidenceConfig/properties/audit_offhost_shipping- Purpose source
- schema description
- Reviewed intent profile
notary_deployment_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
deployment.evidence.signer_custody_approvedOperator asserts a production review has approved signer custody for
this deployment. Provider kind is not proof of custody: PKCS#11 modules
can be backed by either hardware or software tokens.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentEvidenceConfig/properties/signer_custody_approved- Purpose source
- schema description
- Reviewed intent profile
notary_deployment_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
deployment.waivers[].expiresDeclares Notary deployment posture and reviewed waiver metadata used by operator checks.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentWaiverConfig/properties/expires- Purpose source
- reviewed profile
- Reviewed intent profile
notary_deployment_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
deployment.waivers[].findingDeclares Notary deployment posture and reviewed waiver metadata used by operator checks.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentWaiverConfig/properties/finding- Purpose source
- reviewed profile
- Reviewed intent profile
notary_deployment_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
deployment.waivers[].referenceDeclares Notary deployment posture and reviewed waiver metadata used by operator checks.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentWaiverConfig/properties/reference- Purpose source
- reviewed profile
- Reviewed intent profile
notary_deployment_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/DeploymentWaiverReference
deployment.waivers[].summaryStructurally valid deployment-waiver summary. Contextual authorization-value and private-key marker exclusions require semantic producer validation.
- Path kind
- property
- JSON Schema pointer
/$defs/DeploymentWaiverConfig/properties/summary- Purpose source
- schema description
- Reviewed intent profile
notary_deployment_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization supplies the reviewed product-owned scalar default; its value is omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/DeploymentWaiverSummary
evidence.claims[].disclosure.allowedControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureConfig/properties/allowed- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].disclosure.allowed[]Controls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- array item
- JSON Schema pointer
/$defs/DisclosureConfig/properties/allowed/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].disclosure.defaultControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureConfig/properties/default- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].disclosure.downgradeControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/DisclosureConfig/properties/downgrade- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
auth.api_keys[].authorization_details.assisted_access_context.channelControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAssistedAccessContext/properties/channel- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.assisted_access_context.channelControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAssistedAccessContext/properties/channel- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
audit.hash_secret_envControls Notary audit delivery, retention, hashing, and failure behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuditConfig/properties/hash_secret_env- Purpose source
- reviewed profile
- Reviewed intent profile
notary_audit_secret_reference- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
audit.max_filesControls Notary audit delivery, retention, hashing, and failure behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuditConfig/properties/max_files- Purpose source
- reviewed profile
- Reviewed intent profile
notary_audit_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
audit.max_size_mbControls Notary audit delivery, retention, hashing, and failure behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuditConfig/properties/max_size_mb- Purpose source
- reviewed profile
- Reviewed intent profile
notary_audit_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
audit.pathControls Notary audit delivery, retention, hashing, and failure behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuditConfig/properties/path- Purpose source
- reviewed profile
- Reviewed intent profile
notary_audit_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
audit.sinkControls Notary audit delivery, retention, hashing, and failure behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuditConfig/properties/sink- Purpose source
- reviewed profile
- Reviewed intent profile
notary_audit_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
audit.syslog_socket_pathControls Notary audit delivery, retention, hashing, and failure behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuditConfig/properties/syslog_socket_path- Purpose source
- reviewed profile
- Reviewed intent profile
notary_audit_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.access_token_signingControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthConfig/properties/access_token_signing- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/AccessTokenSigningConfig
auth.api_keysControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthConfig/properties/api_keys- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceAuthConfig/properties/api_keys/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/EvidenceCredentialConfig
auth.bearer_tokensControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthConfig/properties/bearer_tokens- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceAuthConfig/properties/bearer_tokens/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/EvidenceCredentialConfig
auth.oidcControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthConfig/properties/oidc- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
auth.api_keys[].authorization_details.access_modeControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/access_mode- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.access_modeControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/access_mode- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.actionsControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/actions- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.actionsControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/actions- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.actions[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/actions/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.actions[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/actions/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.assisted_access_contextControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/assisted_access_context- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.assisted_access_contextControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/assisted_access_context- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.assurance_levelControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/assurance_level- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.assurance_levelControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/assurance_level- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.claimsControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/claims- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.claimsControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/claims- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.claims[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/claims/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object or string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/ClaimRef
auth.bearer_tokens[].authorization_details.claims[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/claims/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object or string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/ClaimRef
auth.api_keys[].authorization_details.consent_refControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/consent_ref- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.consent_refControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/consent_ref- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.disclosureControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/disclosure- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.disclosureControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/disclosure- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.formatControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/format- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.formatControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/format- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.jurisdictionControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/jurisdiction- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.jurisdictionControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/jurisdiction- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.legal_basis_refControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/legal_basis_ref- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.legal_basis_refControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/legal_basis_ref- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.locationsControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/locations- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.locationsControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/locations- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.locations[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/locations/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.locations[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/locations/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.purposeControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/purpose- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.purposeControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/purpose- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.relationshipControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/relationship- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.relationshipControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/relationship- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.schema_versionControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/schema_version- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.schema_versionControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/schema_version- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.subjectControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/subject- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.subjectControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/subject- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.targetControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/target- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.targetControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/target- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.typeControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.typeControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationDetails/properties/type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.relationship.proof_claimControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationRelationship/properties/proof_claim- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.relationship.proof_claimControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationRelationship/properties/proof_claim- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.relationship.relationship_typeControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationRelationship/properties/relationship_type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.relationship.relationship_typeControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationRelationship/properties/relationship_type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.subject.binding_claimControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationSubject/properties/binding_claim- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.subject.binding_claimControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationSubject/properties/binding_claim- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.subject.id_typeControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationSubject/properties/id_type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.subject.id_typeControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationSubject/properties/id_type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.target.idControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationTarget/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.target.idControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationTarget/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].authorization_details.target.id_typeControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationTarget/properties/id_type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_details.target.id_typeControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceAuthorizationTarget/properties/id_type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.allowed_purposesControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/allowed_purposes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.allowed_purposes[]Controls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceConfig/properties/allowed_purposes/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.api_base_urlControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/api_base_url- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.api_versionControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/api_version- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claimsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/claims- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[]Controls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceConfig/properties/claims/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/ClaimDefinition
evidence.claims_urlControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/claims_url- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.concurrencyControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/concurrency- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/ConcurrencyConfig
evidence.credential_profilesControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/credential_profiles- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.credential_profiles.*Each reviewed key names a credential profile and each value defines its exact claims, format, and issuance contract.
- Path kind
- map value
- JSON Schema pointer
/$defs/EvidenceConfig/properties/credential_profiles/additionalProperties- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_credential_profiles_open_map- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/CredentialProfileConfig
evidence.enabledControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/enabled- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.formats_urlControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/formats_url- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.inline_batch_limitControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/inline_batch_limit- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.machine_quotaControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/machine_quota- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/MachineQuotaConfig
evidence.max_credential_validity_secondsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/max_credential_validity_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.relayThe one Registry Relay connection available to registry-backed claims.
Authentication remains a reloadable local file reference; core never
loads the bearer token value.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/relay- Purpose source
- schema description
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.service_idControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/service_id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.signing_keysControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/signing_keys- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.signing_keys.*Each reviewed key names a signing-key binding and each value references the operator-managed signing material and lifecycle metadata.
- Path kind
- map value
- JSON Schema pointer
/$defs/EvidenceConfig/properties/signing_keys/additionalProperties- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_signing_keys_open_map- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SigningKeyConfig
evidence.variablesClosed union of request variables declared by authored services.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceConfig/properties/variables- Purpose source
- schema description
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.variables.*Each reviewed key names a Notary evidence variable and each value defines its bounded source and evaluation contract.
- Path kind
- map value
- JSON Schema pointer
/$defs/EvidenceConfig/properties/variables/additionalProperties- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_variables_open_map- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- structural
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/RequestVariableConfig
auth.api_keys[].authorization_detailsVersioned authorization fields shared by static configuration and token/OIDC JSON.
Unknown metadata is intentionally ignored for forward-compatible interoperability.
Authorization decisions consume only the modeled fields and must never infer authority
from an unrecognized extension.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceCredentialConfig/properties/authorization_details- Purpose source
- schema description
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].authorization_detailsVersioned authorization fields shared by static configuration and token/OIDC JSON.
Unknown metadata is intentionally ignored for forward-compatible interoperability.
Authorization decisions consume only the modeled fields and must never infer authority
from an unrecognized extension.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceCredentialConfig/properties/authorization_details- Purpose source
- schema description
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].fingerprintControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceCredentialConfig/properties/fingerprint- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/CredentialFingerprintRef
auth.bearer_tokens[].fingerprintControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceCredentialConfig/properties/fingerprint- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/CredentialFingerprintRef
auth.api_keys[].idControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceCredentialConfig/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].idControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceCredentialConfig/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].scopesControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceCredentialConfig/properties/scopes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].scopesControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceCredentialConfig/properties/scopes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.api_keys[].scopes[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceCredentialConfig/properties/scopes/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.bearer_tokens[].scopes[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceCredentialConfig/properties/scopes/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.oidc.allow_insecure_localhostControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/allow_insecure_localhost- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
auth.oidc.allowed_algorithmsControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/allowed_algorithms- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
auth.oidc.allowed_algorithms[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/allowed_algorithms/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
auth.oidc.allowed_clientsControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/allowed_clients- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
auth.oidc.allowed_clients[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/allowed_clients/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
auth.oidc.allowed_token_typesControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/allowed_token_types- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.oidc.allowed_token_types[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/allowed_token_types/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.oidc.audiencesControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/audiences- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.oidc.audiences[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/audiences/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.oidc.issuerControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/issuer- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.oidc.jwks_urlControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/jwks_url- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.oidc.leewayA humantime duration string. The runtime parser remains authoritative for its complete grammar.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/leeway- Purpose source
- schema description
- Reviewed intent profile
notary_auth_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/HumantimeDuration
auth.oidc.principal_claimControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/principal_claim- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
auth.oidc.scope_claimControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/scope_claim- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
auth.oidc.scope_mapControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/scope_map- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
auth.oidc.scope_map.*Each reviewed key is an external token scope and each value is the bounded Notary scope mapping granted for that exact token scope.
- Path kind
- map value
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/scope_map/additionalProperties- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_oidc_scope_map_open_map- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- structural
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
auth.oidc.scope_map.*[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/scope_map/additionalProperties/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
auth.oidc.scope_separatorControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/scope_separator- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
auth.oidc.userinfo_endpointControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/userinfo_endpoint- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.oidc.userinfo_issuersControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/userinfo_issuers- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auth.oidc.userinfo_issuers[]Controls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- array item
- JSON Schema pointer
/$defs/EvidenceOidcAuthConfig/properties/userinfo_issuers/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
federation.clock_leeway_secondsControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationConfig/properties/clock_leeway_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.emergency_denylistControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationConfig/properties/emergency_denylist- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/FederationEmergencyDenylistConfig
federation.enabledControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationConfig/properties/enabled- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.evaluation_profilesControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationConfig/properties/evaluation_profiles- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.evaluation_profiles[]Controls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/FederationConfig/properties/evaluation_profiles/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/FederationEvaluationProfileConfig
federation.federation_apiControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationConfig/properties/federation_api- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.inbound_body_limit_bytesControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationConfig/properties/inbound_body_limit_bytes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.issuerControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationConfig/properties/issuer- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
federation.jwks_uriControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationConfig/properties/jwks_uri- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.max_request_lifetime_secondsControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationConfig/properties/max_request_lifetime_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.node_idControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationConfig/properties/node_id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.pairwise_subject_hashControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationConfig/properties/pairwise_subject_hash- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/FederationPairwiseSubjectHashConfig
federation.peersControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationConfig/properties/peers- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.peers[]Controls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/FederationConfig/properties/peers/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/FederationPeerConfig
federation.response_shapingControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationConfig/properties/response_shaping- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/FederationResponseShapingConfig
federation.signingControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationConfig/properties/signing- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/FederationSigningConfig
federation.supported_protocol_versionsControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationConfig/properties/supported_protocol_versions- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.supported_protocol_versions[]Controls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/FederationConfig/properties/supported_protocol_versions/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.emergency_denylist.kidsControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationEmergencyDenylistConfig/properties/kids- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.emergency_denylist.kids[]Controls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/FederationEmergencyDenylistConfig/properties/kids/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.emergency_denylist.node_idsControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationEmergencyDenylistConfig/properties/node_ids- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.emergency_denylist.node_ids[]Controls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/FederationEmergencyDenylistConfig/properties/node_ids/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.evaluation_profiles[].assurance_levelControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationEvaluationProfileConfig/properties/assurance_level- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.evaluation_profiles[].claim_idControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationEvaluationProfileConfig/properties/claim_id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.evaluation_profiles[].consent_refControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationEvaluationProfileConfig/properties/consent_ref- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.evaluation_profiles[].disclosureControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationEvaluationProfileConfig/properties/disclosure- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.evaluation_profiles[].idControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationEvaluationProfileConfig/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.evaluation_profiles[].jurisdictionControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationEvaluationProfileConfig/properties/jurisdiction- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.evaluation_profiles[].legal_basis_refControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationEvaluationProfileConfig/properties/legal_basis_ref- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.evaluation_profiles[].max_claim_result_age_secondsControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationEvaluationProfileConfig/properties/max_claim_result_age_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.evaluation_profiles[].rulesetControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationEvaluationProfileConfig/properties/ruleset- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.evaluation_profiles[].subject_id_typeControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationEvaluationProfileConfig/properties/subject_id_type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
federation.pairwise_subject_hash.secret_envControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationPairwiseSubjectHashConfig/properties/secret_env- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_secret_reference- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
federation.peers[].allow_insecure_localhostControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationPeerConfig/properties/allow_insecure_localhost- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.peers[].allow_insecure_private_networkControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationPeerConfig/properties/allow_insecure_private_network- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.peers[].allowed_profilesControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationPeerConfig/properties/allowed_profiles- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.peers[].allowed_profiles[]Controls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/FederationPeerConfig/properties/allowed_profiles/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.peers[].allowed_protocol_versionsControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationPeerConfig/properties/allowed_protocol_versions- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.peers[].allowed_protocol_versions[]Controls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/FederationPeerConfig/properties/allowed_protocol_versions/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.peers[].allowed_purposesControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationPeerConfig/properties/allowed_purposes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.peers[].allowed_purposes[]Controls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/FederationPeerConfig/properties/allowed_purposes/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.peers[].evaluation_scopesControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationPeerConfig/properties/evaluation_scopes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.peers[].evaluation_scopes[]Controls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/FederationPeerConfig/properties/evaluation_scopes/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.peers[].issuerControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationPeerConfig/properties/issuer- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
federation.peers[].jwks_uriControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationPeerConfig/properties/jwks_uri- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.peers[].node_idControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationPeerConfig/properties/node_id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.response_shaping.minimum_denial_latency_msControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationResponseShapingConfig/properties/minimum_denial_latency_ms- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
federation.signing.signing_keyControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/FederationSigningConfig/properties/signing_key- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.credential_profiles.*.holder_binding.allowed_did_methodsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/HolderBindingConfig/properties/allowed_did_methods- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.credential_profiles.*.holder_binding.allowed_did_methods[]Controls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- array item
- JSON Schema pointer
/$defs/HolderBindingConfig/properties/allowed_did_methods/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.credential_profiles.*.holder_binding.modeControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/HolderBindingConfig/properties/mode- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.credential_profiles.*.holder_binding.proof_of_possessionControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/HolderBindingConfig/properties/proof_of_possession- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.machine_quota.enabledControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/MachineQuotaConfig/properties/enabled- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.machine_quota.subjects_per_minuteControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/MachineQuotaConfig/properties/subjects_per_minute- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
instance.environmentIdentifies the Notary instance and its deployment environment for operational correlation.
- Path kind
- property
- JSON Schema pointer
/$defs/NotaryInstanceConfig/properties/environment- Purpose source
- reviewed profile
- Reviewed intent profile
notary_instance_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
instance.idIdentifies the Notary instance and its deployment environment for operational correlation.
- Path kind
- property
- JSON Schema pointer
/$defs/NotaryInstanceConfig/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_instance_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
instance.jurisdictionIdentifies the Notary instance and its deployment environment for operational correlation.
- Path kind
- property
- JSON Schema pointer
/$defs/NotaryInstanceConfig/properties/jurisdiction- Purpose source
- reviewed profile
- Reviewed intent profile
notary_instance_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
instance.ownerIdentifies the Notary instance and its deployment environment for operational correlation.
- Path kind
- property
- JSON Schema pointer
/$defs/NotaryInstanceConfig/properties/owner- Purpose source
- reviewed profile
- Reviewed intent profile
notary_instance_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
instance.public_base_urlIdentifies the Notary instance and its deployment environment for operational correlation.
- Path kind
- property
- JSON Schema pointer
/$defs/NotaryInstanceConfig/properties/public_base_url- Purpose source
- reviewed profile
- Reviewed intent profile
notary_instance_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.authorization.require_pkce_methodControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciAuthorizationConfig/properties/require_pkce_method- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.accepted_token_audiencesControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/accepted_token_audiences- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.accepted_token_audiences[]Controls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/accepted_token_audiences/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.authorizationControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/authorization- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/Oid4vciAuthorizationConfig
oid4vci.authorization_serversControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/authorization_servers- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.authorization_servers[]Controls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/authorization_servers/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.credential_configurationsControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/credential_configurations- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*Each reviewed key names an OpenID4VCI credential configuration and each value defines the advertised and issued credential contract.
- Path kind
- map value
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/credential_configurations/additionalProperties- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_credential_configurations_open_map- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/Oid4vciCredentialConfigurationConfig
oid4vci.credential_endpointControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/credential_endpoint- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_issuerControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/credential_issuer- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.displayControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/display- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.display[]Controls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/display/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/Oid4vciIssuerDisplayConfig
oid4vci.enabledControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/enabled- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.nonceControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/nonce- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/Oid4vciNonceConfig
oid4vci.nonce_endpointControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/nonce_endpoint- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.offer_endpointControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/offer_endpoint- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.pre_authorized_codeControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/pre_authorized_code- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/Oid4vciPreAuthorizedCodeConfig
oid4vci.proofControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciConfig/properties/proof- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/Oid4vciProofConfig
oid4vci.credential_configurations.*.claims[].display_nameControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialClaimConfig/properties/display_name- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.claims[].idControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialClaimConfig/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.claims[].output_pathControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialClaimConfig/properties/output_path- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.claims[].output_path[]Controls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/Oid4vciCredentialClaimConfig/properties/output_path/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.claims[].sdControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialClaimConfig/properties/sd- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.claim_idControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialConfigurationConfig/properties/claim_id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.claimsControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialConfigurationConfig/properties/claims- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.claims[]Controls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/Oid4vciCredentialConfigurationConfig/properties/claims/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/Oid4vciCredentialClaimConfig
oid4vci.credential_configurations.*.credential_profileControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialConfigurationConfig/properties/credential_profile- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.cryptographic_binding_methods_supportedControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialConfigurationConfig/properties/cryptographic_binding_methods_supported- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.cryptographic_binding_methods_supported[]Controls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/Oid4vciCredentialConfigurationConfig/properties/cryptographic_binding_methods_supported/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.displayControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialConfigurationConfig/properties/display- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/Oid4vciCredentialDisplayConfig
oid4vci.credential_configurations.*.display_nameControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialConfigurationConfig/properties/display_name- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.formatControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialConfigurationConfig/properties/format- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.proof_signing_alg_values_supportedControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialConfigurationConfig/properties/proof_signing_alg_values_supported- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.proof_signing_alg_values_supported[]Controls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/Oid4vciCredentialConfigurationConfig/properties/proof_signing_alg_values_supported/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.scopeControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialConfigurationConfig/properties/scope- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.vctControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialConfigurationConfig/properties/vct- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.display.background_colorControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialDisplayConfig/properties/background_color- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.display.background_imageControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialDisplayConfig/properties/background_image- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.display.descriptionControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialDisplayConfig/properties/description- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.display.localeControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialDisplayConfig/properties/locale- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.display.logoControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialDisplayConfig/properties/logo- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.display.secondary_imageControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialDisplayConfig/properties/secondary_image- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.display.text_colorControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciCredentialDisplayConfig/properties/text_color- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.display.background_image.alt_textControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciDisplayImageConfig/properties/alt_text- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.display.logo.alt_textControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciDisplayImageConfig/properties/alt_text- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.display.secondary_image.alt_textControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciDisplayImageConfig/properties/alt_text- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.display[].logo.alt_textControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciDisplayImageConfig/properties/alt_text- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.credential_configurations.*.display.background_image.uriControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciDisplayImageConfig/properties/uri- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.display.logo.uriControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciDisplayImageConfig/properties/uri- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.display.secondary_image.uriControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciDisplayImageConfig/properties/uri- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.display[].logo.uriControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciDisplayImageConfig/properties/uri- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.credential_configurations.*.display.background_image.urlControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciDisplayImageConfig/properties/url- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.display.logo.urlControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciDisplayImageConfig/properties/url- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.credential_configurations.*.display.secondary_image.urlControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciDisplayImageConfig/properties/url- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.display[].logo.urlControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciDisplayImageConfig/properties/url- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.pre_authorized_code.esignet.allow_insecure_localhostAllow `http` loopback URLs for the eSignet endpoints and JWKS transport.
For local development and tests only.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciEsignetRpConfig/properties/allow_insecure_localhost- Purpose source
- schema description
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.pre_authorized_code.esignet.authorize_urleSignet authorize endpoint.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciEsignetRpConfig/properties/authorize_url- Purpose source
- schema description
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.pre_authorized_code.esignet.client_idConfidential client id the Notary presents to eSignet.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciEsignetRpConfig/properties/client_id- Purpose source
- schema description
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.pre_authorized_code.esignet.client_signing_key_id`evidence.signing_keys` entry used to sign the eSignet
`private_key_jwt` client assertion.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciEsignetRpConfig/properties/client_signing_key_id- Purpose source
- schema description
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.pre_authorized_code.esignet.issuereSignet OIDC issuer, pinned when validating the returned `id_token`.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciEsignetRpConfig/properties/issuer- Purpose source
- schema description
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.pre_authorized_code.esignet.jwks_urieSignet JWKS URI, used to resolve the `id_token` signing key by `kid`.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciEsignetRpConfig/properties/jwks_uri- Purpose source
- schema description
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.pre_authorized_code.esignet.login_state_ttl_secondsLifetime of the short-lived login state (PKCE verifier + nonce +
selection) reserved between `offer/start` and `offer/callback`.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciEsignetRpConfig/properties/login_state_ttl_seconds- Purpose source
- schema description
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.pre_authorized_code.esignet.redirect_uriNotary callback the citizen browser is redirected back to.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciEsignetRpConfig/properties/redirect_uri- Purpose source
- schema description
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.pre_authorized_code.esignet.scopesOAuth scopes requested at eSignet.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciEsignetRpConfig/properties/scopes- Purpose source
- schema description
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.pre_authorized_code.esignet.scopes[]Controls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/Oid4vciEsignetRpConfig/properties/scopes/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.pre_authorized_code.esignet.token_urlControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciEsignetRpConfig/properties/token_url- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.pre_authorized_code.esignet.userinfo_urleSignet userinfo endpoint. Required when the subject-binding claim is
sourced from userinfo rather than the `id_token`; the callback fetches
the userinfo JWS with the eSignet access token and reads the binding
claim from it.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciEsignetRpConfig/properties/userinfo_url- Purpose source
- schema description
- Reviewed intent profile
notary_oid4vci_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
oid4vci.display[].localeControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciIssuerDisplayConfig/properties/locale- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.display[].logoControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciIssuerDisplayConfig/properties/logo- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.display[].nameControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciIssuerDisplayConfig/properties/name- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.nonce.enabledControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciNonceConfig/properties/enabled- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.nonce.ttl_secondsControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciNonceConfig/properties/ttl_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.pre_authorized_code.enabledControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciPreAuthorizedCodeConfig/properties/enabled- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.pre_authorized_code.esignetControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciPreAuthorizedCodeConfig/properties/esignet- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/Oid4vciEsignetRpConfig
oid4vci.pre_authorized_code.pre_authorized_code_ttl_secondsPre-authorized-code lifetime in seconds.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciPreAuthorizedCodeConfig/properties/pre_authorized_code_ttl_seconds- Purpose source
- schema description
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.pre_authorized_code.tx_code`tx_code` (PIN) policy for the pre-authorized-code grant. A `tx_code` is
required by default because a code without a PIN is a bearer credential.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciPreAuthorizedCodeConfig/properties/tx_code- Purpose source
- schema description
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/Oid4vciTxCodeConfig
oid4vci.proof.max_age_secondsControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciProofConfig/properties/max_age_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.proof.max_clock_skew_secondsControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciProofConfig/properties/max_clock_skew_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.pre_authorized_code.tx_code.input_modeControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciTxCodeConfig/properties/input_mode- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.pre_authorized_code.tx_code.lengthControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciTxCodeConfig/properties/length- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
oid4vci.pre_authorized_code.tx_code.requiredControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/Oid4vciTxCodeConfig/properties/required- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].oots.authentication_level_of_assuranceControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/OotsConfig/properties/authentication_level_of_assurance- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].oots.enabledControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/OotsConfig/properties/enabled- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].oots.evidence_type_classificationControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/OotsConfig/properties/evidence_type_classification- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].oots.evidence_type_listControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/OotsConfig/properties/evidence_type_list- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].oots.languagesControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/OotsConfig/properties/languages- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].oots.languages[]Controls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- array item
- JSON Schema pointer
/$defs/OotsConfig/properties/languages/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].oots.reference_frameworkControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/OotsConfig/properties/reference_framework- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].oots.requirementControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/OotsConfig/properties/requirement- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].operations.evaluate.enabledControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/OperationConfig/properties/enabled- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
server.admin_listener.bindA Rust SocketAddr string. The runtime parser remains authoritative for address and port validity.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryAdminListenerConfig/properties/bind- Purpose source
- schema description
- Reviewed intent profile
notary_server_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/SocketAddr
server.admin_listener.modeControls Notary listeners, transport, timeouts, request limits, and administrative endpoints.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryAdminListenerConfig/properties/mode- Purpose source
- reviewed profile
- Reviewed intent profile
notary_server_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- When omitted, Rust deserialization supplies the reviewed product-owned scalar default; its value is omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/RegistryNotaryAdminListenerMode
cel.allow_regexControls bounded CEL evaluation limits used by reviewed Notary policy expressions.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryCelConfig/properties/allow_regex- Purpose source
- reviewed profile
- Reviewed intent profile
notary_cel_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
cel.eval_timeout_msControls bounded CEL evaluation limits used by reviewed Notary policy expressions.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryCelConfig/properties/eval_timeout_ms- Purpose source
- reviewed profile
- Reviewed intent profile
notary_cel_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
cel.max_binding_json_bytesControls bounded CEL evaluation limits used by reviewed Notary policy expressions.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryCelConfig/properties/max_binding_json_bytes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_cel_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
cel.max_expression_bytesControls bounded CEL evaluation limits used by reviewed Notary policy expressions.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryCelConfig/properties/max_expression_bytes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_cel_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
cel.max_list_itemsControls bounded CEL evaluation limits used by reviewed Notary policy expressions.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryCelConfig/properties/max_list_items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_cel_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
cel.max_object_depthControls bounded CEL evaluation limits used by reviewed Notary policy expressions.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryCelConfig/properties/max_object_depth- Purpose source
- reviewed profile
- Reviewed intent profile
notary_cel_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
cel.max_object_keysControls bounded CEL evaluation limits used by reviewed Notary policy expressions.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryCelConfig/properties/max_object_keys- Purpose source
- reviewed profile
- Reviewed intent profile
notary_cel_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
cel.max_result_json_bytesControls bounded CEL evaluation limits used by reviewed Notary policy expressions.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryCelConfig/properties/max_result_json_bytes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_cel_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
cel.max_string_bytesControls bounded CEL evaluation limits used by reviewed Notary policy expressions.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryCelConfig/properties/max_string_bytes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_cel_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
cel.modeControls bounded CEL evaluation limits used by reviewed Notary policy expressions.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryCelConfig/properties/mode- Purpose source
- reviewed profile
- Reviewed intent profile
notary_cel_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
cel.worker_countControls bounded CEL evaluation limits used by reviewed Notary policy expressions.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryCelConfig/properties/worker_count- Purpose source
- reviewed profile
- Reviewed intent profile
notary_cel_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
cel.worker_memory_bytesControls bounded CEL evaluation limits used by reviewed Notary policy expressions.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryCelConfig/properties/worker_memory_bytes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_cel_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
cel.worker_stderr_bytesControls bounded CEL evaluation limits used by reviewed Notary policy expressions.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryCelConfig/properties/worker_stderr_bytes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_cel_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
server.cors.allowed_originsControls Notary listeners, transport, timeouts, request limits, and administrative endpoints.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryCorsConfig/properties/allowed_origins- Purpose source
- reviewed profile
- Reviewed intent profile
notary_server_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
server.cors.allowed_origins[]Controls Notary listeners, transport, timeouts, request limits, and administrative endpoints.
- Path kind
- array item
- JSON Schema pointer
/$defs/RegistryNotaryCorsConfig/properties/allowed_origins/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_server_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
server.admin_listenerControls Notary listeners, transport, timeouts, request limits, and administrative endpoints.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryHttpConfig/properties/admin_listener- Purpose source
- reviewed profile
- Reviewed intent profile
notary_server_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/RegistryNotaryAdminListenerConfig
server.bindA Rust SocketAddr string. The runtime parser remains authoritative for address and port validity.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryHttpConfig/properties/bind- Purpose source
- schema description
- Reviewed intent profile
notary_server_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/SocketAddr
server.corsControls Notary listeners, transport, timeouts, request limits, and administrative endpoints.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryHttpConfig/properties/cors- Purpose source
- reviewed profile
- Reviewed intent profile
notary_server_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/RegistryNotaryCorsConfig
server.http1_header_read_timeoutA humantime duration string. The runtime parser remains authoritative for its complete grammar.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryHttpConfig/properties/http1_header_read_timeout- Purpose source
- schema description
- Reviewed intent profile
notary_server_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/HumantimeDuration
server.max_connectionsControls Notary listeners, transport, timeouts, request limits, and administrative endpoints.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryHttpConfig/properties/max_connections- Purpose source
- reviewed profile
- Reviewed intent profile
notary_server_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
server.openapi_requires_authControls Notary listeners, transport, timeouts, request limits, and administrative endpoints.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryHttpConfig/properties/openapi_requires_auth- Purpose source
- reviewed profile
- Reviewed intent profile
notary_server_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the reviewed product-owned scalar default; its value is omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
server.request_body_timeoutA humantime duration string. The runtime parser remains authoritative for its complete grammar.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryHttpConfig/properties/request_body_timeout- Purpose source
- schema description
- Reviewed intent profile
notary_server_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/HumantimeDuration
server.request_timeoutA humantime duration string. The runtime parser remains authoritative for its complete grammar.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryHttpConfig/properties/request_timeout- Purpose source
- schema description
- Reviewed intent profile
notary_server_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/HumantimeDuration
server.trusted_proxy_ipsControls Notary listeners, transport, timeouts, request limits, and administrative endpoints.
- Path kind
- property
- JSON Schema pointer
/$defs/RegistryNotaryHttpConfig/properties/trusted_proxy_ips- Purpose source
- reviewed profile
- Reviewed intent profile
notary_server_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned empty collection required by this runtime contract.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
server.trusted_proxy_ips[]Controls Notary listeners, transport, timeouts, request limits, and administrative endpoints.
- Path kind
- array item
- JSON Schema pointer
/$defs/RegistryNotaryHttpConfig/properties/trusted_proxy_ips/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_server_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.relay.allow_insecure_localhostControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayConnectionConfig/properties/allow_insecure_localhost- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.relay.allowed_private_cidrsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayConnectionConfig/properties/allowed_private_cidrs- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.relay.allowed_private_cidrs[]An IP network CIDR string. The runtime parser remains authoritative for address and prefix validity.
- Path kind
- array item
- JSON Schema pointer
/$defs/RelayConnectionConfig/properties/allowed_private_cidrs/items- Purpose source
- schema description
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/IpNet
evidence.relay.base_urlControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayConnectionConfig/properties/base_url- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.relay.max_in_flightControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayConnectionConfig/properties/max_in_flight- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.relay.token_fileControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayConnectionConfig/properties/token_file- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_secret_reference- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.relay.workload_client_idControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayConnectionConfig/properties/workload_client_id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.claims[].evidence_mode.consultations.*.inputsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayConsultationConfig/properties/inputs- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].evidence_mode.consultations.*.inputs.*A supported consultation input path. The runtime parser remains authoritative for exact stable-name bounds.
- Path kind
- map value
- JSON Schema pointer
/$defs/RelayConsultationConfig/properties/inputs/additionalProperties- Purpose source
- schema description
- Reviewed intent profile
notary_evidence_claims_evidence_mode_consultations_inputs_open_map- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- structural
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/RelayConsultationInput
evidence.claims[].evidence_mode.consultations.*.outputsComplete closed public output schema expected from the pinned profile.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayConsultationConfig/properties/outputs- Purpose source
- schema description
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].evidence_mode.consultations.*.outputs.*Each reviewed key names a consultation output and each value defines its bounded evidence-result interpretation.
- Path kind
- map value
- JSON Schema pointer
/$defs/RelayConsultationConfig/properties/outputs/additionalProperties- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_claims_evidence_mode_consultations_outputs_open_map- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- structural
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/RelayOutputContract
evidence.claims[].evidence_mode.consultations.*.profileControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayConsultationConfig/properties/profile- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/RelayConsultationProfileRef
evidence.claims[].evidence_mode.consultations.*.profile.contract_hashControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayConsultationProfileRef/properties/contract_hash- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.claims[].evidence_mode.consultations.*.profile.idControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayConsultationProfileRef/properties/id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].evidence_mode.consultations.*.outputs.*.nullableControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayOutputContract/oneOf/0/properties/nullable- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].evidence_mode.consultations.*.outputs.*.typeControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayOutputContract/oneOf/0/properties/type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].evidence_mode.consultations.*.outputs.*.maximumControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayOutputContract/oneOf/1/properties/maximum- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].evidence_mode.consultations.*.outputs.*.minimumControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayOutputContract/oneOf/1/properties/minimum- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].evidence_mode.consultations.*.outputs.*.max_bytesControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RelayOutputContract/oneOf/2/properties/max_bytes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.variables.*.fromControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RequestVariableConfig/properties/from- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.variables.*.typeControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RequestVariableConfig/properties/type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/RequestVariableType
evidence.claims[].rule.consultationControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RuleConfig/oneOf/0/properties/consultation- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].rule.outputControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RuleConfig/oneOf/0/properties/output- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].rule.typeControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RuleConfig/oneOf/0/properties/type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].rule.bindingsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RuleConfig/oneOf/2/properties/bindings- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/CelBindingsConfig
evidence.claims[].rule.expressionControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/RuleConfig/oneOf/2/properties/expression- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].evidence_mode.consultationsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SealedClaimEvidenceMode/oneOf/0/properties/consultations- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.claims[].evidence_mode.consultations.*Each reviewed key names a Relay consultation and each value defines the bounded consultation contract used to support this evidence claim.
- Path kind
- map value
- JSON Schema pointer
/$defs/SealedClaimEvidenceMode/oneOf/0/properties/consultations/additionalProperties- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_claims_evidence_mode_consultations_open_map- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- structural
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/RelayConsultationConfig
evidence.claims[].evidence_mode.typeControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SealedClaimEvidenceMode/oneOf/0/properties/type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
evidence.signing_keys.*.algControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SigningKeyConfig/properties/alg- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.signing_keys.*.key_id_hexControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SigningKeyConfig/properties/key_id_hex- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.signing_keys.*.key_labelControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SigningKeyConfig/properties/key_label- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.signing_keys.*.kidControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SigningKeyConfig/properties/kid- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.signing_keys.*.module_pathControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SigningKeyConfig/properties/module_path- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.signing_keys.*.password_envControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SigningKeyConfig/properties/password_env- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_secret_reference- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.signing_keys.*.pathControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SigningKeyConfig/properties/path- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_secret_reference- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.signing_keys.*.pin_envControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SigningKeyConfig/properties/pin_env- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_secret_reference- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.signing_keys.*.private_jwk_envControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SigningKeyConfig/properties/private_jwk_env- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_secret_reference- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.signing_keys.*.providerControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SigningKeyConfig/properties/provider- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SigningKeyProviderSchema
evidence.signing_keys.*.public_jwk_envControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SigningKeyConfig/properties/public_jwk_env- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.signing_keys.*.publish_until_unix_secondsControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SigningKeyConfig/properties/publish_until_unix_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer or null
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
evidence.signing_keys.*.statusControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SigningKeyConfig/properties/status- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SigningKeyStatusSchema
evidence.signing_keys.*.token_labelControls evidence claims, Relay consultations, disclosure, signing keys, variables, and credential profiles.
- Path kind
- property
- JSON Schema pointer
/$defs/SigningKeyConfig/properties/token_label- Purpose source
- reviewed profile
- Reviewed intent profile
notary_evidence_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
state.postgresqlControls Notary durable state storage, database trust, timeouts, connection limits, and sensitive-state protection.
- Path kind
- property
- JSON Schema pointer
/$defs/StateConfig/properties/postgresql- Purpose source
- reviewed profile
- Reviewed intent profile
notary_state_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/StatePostgresqlConfig
state.storageControls Notary durable state storage, database trust, timeouts, connection limits, and sensitive-state protection.
- Path kind
- property
- JSON Schema pointer
/$defs/StateConfig/properties/storage- Purpose source
- reviewed profile
- Reviewed intent profile
notary_state_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
state.postgresql.connect_timeout_msControls Notary durable state storage, database trust, timeouts, connection limits, and sensitive-state protection.
- Path kind
- property
- JSON Schema pointer
/$defs/StatePostgresqlConfig/properties/connect_timeout_ms- Purpose source
- reviewed profile
- Reviewed intent profile
notary_state_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
state.postgresql.max_connectionsControls Notary durable state storage, database trust, timeouts, connection limits, and sensitive-state protection.
- Path kind
- property
- JSON Schema pointer
/$defs/StatePostgresqlConfig/properties/max_connections- Purpose source
- reviewed profile
- Reviewed intent profile
notary_state_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
state.postgresql.operation_timeout_msControls Notary durable state storage, database trust, timeouts, connection limits, and sensitive-state protection.
- Path kind
- property
- JSON Schema pointer
/$defs/StatePostgresqlConfig/properties/operation_timeout_ms- Purpose source
- reviewed profile
- Reviewed intent profile
notary_state_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
state.postgresql.root_certificate_pathControls Notary durable state storage, database trust, timeouts, connection limits, and sensitive-state protection.
- Path kind
- property
- JSON Schema pointer
/$defs/StatePostgresqlConfig/properties/root_certificate_path- Purpose source
- reviewed profile
- Reviewed intent profile
notary_state_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
state.postgresql.sensitive_state_key_envControls Notary durable state storage, database trust, timeouts, connection limits, and sensitive-state protection.
- Path kind
- property
- JSON Schema pointer
/$defs/StatePostgresqlConfig/properties/sensitive_state_key_env- Purpose source
- reviewed profile
- Reviewed intent profile
notary_state_secret_reference- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
state.postgresql.url_envControls Notary durable state storage, database trust, timeouts, connection limits, and sensitive-state protection.
- Path kind
- property
- JSON Schema pointer
/$defs/StatePostgresqlConfig/properties/url_env- Purpose source
- reviewed profile
- Reviewed intent profile
notary_state_secret_reference- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- secret reference
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.citizen_clients.allowed_audiencesControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessCitizenClientsConfig/properties/allowed_audiences- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.citizen_clients.allowed_audiences[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessCitizenClientsConfig/properties/allowed_audiences/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.citizen_clients.allowed_client_idsControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessCitizenClientsConfig/properties/allowed_client_ids- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.citizen_clients.allowed_client_ids[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessCitizenClientsConfig/properties/allowed_client_ids/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.allowed_claimsControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/allowed_claims- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.allowed_claims[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/allowed_claims/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.allowed_disclosuresControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/allowed_disclosures- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.allowed_disclosures[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/allowed_disclosures/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.allowed_formatsControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/allowed_formats- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.allowed_formats[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/allowed_formats/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.allowed_operationsControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/allowed_operations- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SubjectAccessOperationsConfig
subject_access.allowed_purposesControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/allowed_purposes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.allowed_purposes[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/allowed_purposes/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.allowed_wallet_originsControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/allowed_wallet_origins- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.allowed_wallet_origins[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/allowed_wallet_origins/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.citizen_clientsControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/citizen_clients- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SubjectAccessCitizenClientsConfig
subject_access.credential_profilesControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/credential_profiles- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.credential_profiles[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/credential_profiles/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.delegationControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/delegation- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SubjectAccessDelegationConfig
subject_access.enabledControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/enabled- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.rate_limitsControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/rate_limits- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SubjectAccessRateLimitsConfig
subject_access.required_scopesControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/required_scopes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.required_scopes[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/required_scopes/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.scope_policyControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/scope_policy- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SubjectAccessScopePolicy
subject_access.subject_bindingControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/subject_binding- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SubjectAccessSubjectBindingConfig
subject_access.token_policyControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessConfig/properties/token_policy- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SubjectAccessTokenPolicyConfig
subject_access.delegation.allowed_relationships[].allowed_claimsControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessDelegatedRelationshipConfig/properties/allowed_claims- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.delegation.allowed_relationships[].allowed_claims[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessDelegatedRelationshipConfig/properties/allowed_claims/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.delegation.allowed_relationships[].allowed_disclosuresControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessDelegatedRelationshipConfig/properties/allowed_disclosures- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.delegation.allowed_relationships[].allowed_disclosures[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessDelegatedRelationshipConfig/properties/allowed_disclosures/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.delegation.allowed_relationships[].allowed_formatsControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessDelegatedRelationshipConfig/properties/allowed_formats- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.delegation.allowed_relationships[].allowed_formats[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessDelegatedRelationshipConfig/properties/allowed_formats/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.delegation.allowed_relationships[].allowed_purposesControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessDelegatedRelationshipConfig/properties/allowed_purposes- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.delegation.allowed_relationships[].allowed_purposes[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessDelegatedRelationshipConfig/properties/allowed_purposes/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.delegation.allowed_relationships[].credential_profilesControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessDelegatedRelationshipConfig/properties/credential_profiles- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.delegation.allowed_relationships[].credential_profiles[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessDelegatedRelationshipConfig/properties/credential_profiles/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.delegation.allowed_relationships[].proof_claimControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessDelegatedRelationshipConfig/properties/proof_claim- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.delegation.allowed_relationships[].relationship_typeControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessDelegatedRelationshipConfig/properties/relationship_type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- no schema default
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.delegation.allowed_relationships[].target_id_typeControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessDelegatedRelationshipConfig/properties/target_id_type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or string
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.delegation.allowed_relationshipsControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessDelegationConfig/properties/allowed_relationships- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.delegation.allowed_relationships[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessDelegationConfig/properties/allowed_relationships/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SubjectAccessDelegatedRelationshipConfig
subject_access.delegation.enabledControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessDelegationConfig/properties/enabled- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.allowed_operations.batch_evaluateControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessOperationsConfig/properties/batch_evaluate- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.allowed_operations.evaluateControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessOperationsConfig/properties/evaluate- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.allowed_operations.issue_credentialControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessOperationsConfig/properties/issue_credential- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.allowed_operations.renderControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessOperationsConfig/properties/render- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.rate_limits.credential_issuance_per_principal_per_hourControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessRateLimitsConfig/properties/credential_issuance_per_principal_per_hour- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.rate_limits.invalid_token_per_client_address_per_minuteControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessRateLimitsConfig/properties/invalid_token_per_client_address_per_minute- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.rate_limits.per_holder_per_hourControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessRateLimitsConfig/properties/per_holder_per_hour- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.rate_limits.per_principal_per_minuteControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessRateLimitsConfig/properties/per_principal_per_minute- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.rate_limits.subject_mismatch_per_principal_per_hourControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessRateLimitsConfig/properties/subject_mismatch_per_principal_per_hour- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.rate_limits.tx_code_attempts_per_code_per_minutePer-minute cap on `tx_code` attempts against a single
`pre-authorized_code`. Bounds brute force of the numeric PIN at the
pre-authorized-code token endpoint. Defaults to zero so existing
configs that do not enable pre-auth still validate; it must be greater
than zero only when the pre-authorized-code flow is enabled.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessRateLimitsConfig/properties/tx_code_attempts_per_code_per_minute- Purpose source
- schema description
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.subject_binding.allow_sub_as_civil_idControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessSubjectBindingConfig/properties/allow_sub_as_civil_id- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- boolean
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.subject_binding.claim_sourceControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessSubjectBindingConfig/properties/claim_source- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SubjectAccessClaimSource
subject_access.subject_binding.id_typeControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessSubjectBindingConfig/properties/id_type- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.subject_binding.normalizeControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessSubjectBindingConfig/properties/normalize- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SubjectBindingNormalize
subject_access.subject_binding.request_fieldControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessSubjectBindingConfig/properties/request_field- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SubjectId
subject_access.subject_binding.token_claimControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessSubjectBindingConfig/properties/token_claim- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.token_policy.assurance_claim_sourceControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessTokenPolicyConfig/properties/assurance_claim_source- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- rejected
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SubjectAccessAssuranceClaimSource
subject_access.token_policy.max_access_token_lifetime_secondsControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessTokenPolicyConfig/properties/max_access_token_lifetime_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.token_policy.max_auth_age_secondsControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessTokenPolicyConfig/properties/max_auth_age_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.token_policy.max_clock_leeway_secondsControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessTokenPolicyConfig/properties/max_clock_leeway_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.token_policy.max_credential_validity_secondsControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessTokenPolicyConfig/properties/max_credential_validity_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.token_policy.max_evaluation_age_secondsControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessTokenPolicyConfig/properties/max_evaluation_age_seconds- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- integer
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.token_policy.required_acr_valuesControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/$defs/SubjectAccessTokenPolicyConfig/properties/required_acr_values- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- array
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
subject_access.token_policy.required_acr_values[]Controls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- array item
- JSON Schema pointer
/$defs/SubjectAccessTokenPolicyConfig/properties/required_acr_values/items- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- string
- Requiredness
- not applicable
- Null behavior
- rejected
- Empty behavior
- allowed
- Default
- not applicable
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
auditControls Notary audit delivery, retention, hashing, and failure behavior.
- Path kind
- property
- JSON Schema pointer
/properties/audit- Purpose source
- reviewed profile
- Reviewed intent profile
notary_audit_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/EvidenceAuditConfig
authControls Notary caller authentication, authorization details, token verification, and access-token signing.
- Path kind
- property
- JSON Schema pointer
/properties/auth- Purpose source
- reviewed profile
- Reviewed intent profile
notary_auth_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/EvidenceAuthConfig
celControls bounded CEL evaluation limits used by reviewed Notary policy expressions.
- Path kind
- property
- JSON Schema pointer
/properties/cel- Purpose source
- reviewed profile
- Reviewed intent profile
notary_cel_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/RegistryNotaryCelConfig
config_trustOptional governed-configuration local trust state.
Simple local deployments omit this block. Signed/governed apply requires it
so anti-rollback state lives in an explicit durable location.
- Path kind
- property
- JSON Schema pointer
/properties/config_trust- Purpose source
- schema description
- Reviewed intent profile
notary_config_trust_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- null or object
- Requiredness
- optional
- Null behavior
- conditional
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization preserves the product-owned absence state without materializing a configuration value.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
credential_statusControls Notary credential-status publication and retention behavior.
- Path kind
- property
- JSON Schema pointer
/properties/credential_status- Purpose source
- reviewed profile
- Reviewed intent profile
notary_credential_status_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/CredentialStatusConfig
deploymentThe operator-declared `deployment` config block.
An absent profile means an undeclared deployment, which refuses startup. The
`multi_instance` flag is an operator declaration that the instance is one of
several sharing the same workload; it is never inferred.
- Path kind
- property
- JSON Schema pointer
/properties/deployment- Purpose source
- schema description
- Reviewed intent profile
notary_deployment_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/DeploymentConfig
evidenceRegistry Notary configuration. Disabled by default so existing
Registry Relay deployments load unchanged.
- Path kind
- property
- JSON Schema pointer
/properties/evidence- Purpose source
- schema description
- Reviewed intent profile
notary_evidence_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- required
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- no schema default
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/EvidenceConfig
federationControls Notary federation trust, request verification, pairwise identifiers, and bounded peer behavior.
- Path kind
- property
- JSON Schema pointer
/properties/federation- Purpose source
- reviewed profile
- Reviewed intent profile
notary_federation_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/FederationConfig
instanceIdentifies the Notary instance and its deployment environment for operational correlation.
- Path kind
- property
- JSON Schema pointer
/properties/instance- Purpose source
- reviewed profile
- Reviewed intent profile
notary_instance_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/NotaryInstanceConfig
oid4vciControls Notary OpenID4VCI issuer, client, grant, proof, nonce, and credential-configuration behavior.
- Path kind
- property
- JSON Schema pointer
/properties/oid4vci- Purpose source
- reviewed profile
- Reviewed intent profile
notary_oid4vci_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/Oid4vciConfig
serverControls Notary listeners, transport, timeouts, request limits, and administrative endpoints.
- Path kind
- property
- JSON Schema pointer
/properties/server- Purpose source
- reviewed profile
- Reviewed intent profile
notary_server_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- The product-owned JSON Schema publishes the default; its value is intentionally omitted from this value-free reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/RegistryNotaryHttpConfig
stateControls Notary durable state storage, database trust, timeouts, connection limits, and sensitive-state protection.
- Path kind
- property
- JSON Schema pointer
/properties/state- Purpose source
- reviewed profile
- Reviewed intent profile
notary_state_internal- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- bound by environment
- Configuration state
- runtime
- Sensitivity
- internal
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, documentation
- Local schema reference
/$defs/StateConfig
subject_accessControls Notary subject and assisted-access policy, authorization details, and relationship proof behavior.
- Path kind
- property
- JSON Schema pointer
/properties/subject_access- Purpose source
- reviewed profile
- Reviewed intent profile
notary_subject_access_sensitive- Scope
- The complete product-owned Notary runtime configuration accepted by schema validation, Rust deserialization, and operator preflight.
- Type
- object
- Requiredness
- optional
- Null behavior
- rejected
- Empty behavior
- not applicable
- Default
- When omitted, Rust deserialization supplies the product-owned nested default contract; no deployment value is copied into this reference.
- Environment behavior
- narrows reviewed authority
- Configuration state
- runtime
- Sensitivity
- sensitive
- Owners
- notary runtime; notary maintainers
- Products
- notary, docs
- Validation stages
- json schema, rust deserialization, operator preflight
- Diagnostic
Notary runtime configuration does not yet publish a closed general diagnostic code; doctor reports the generic failed status.- Availability
- published
- Stability
- experimental
- Release history
- Not verified
- Migration
- coordinate deployment. Coordinate Notary deployment, key or trust rotation, and rollback review before activating runtime configuration changes.
- Example guidance
- Use synthetic identifiers and non-routable placeholders; never copy credentials, environment values, deployment paths, or country configuration.
- Consumers
- registry notary, docs generator
- Generated artifacts
- notary config, field reference
- Review classes
- contract, notary, security, privacy, documentation
- Local schema reference
/$defs/SubjectAccessConfig
Validation boundary
Section titled “Validation boundary”The generated field entries describe schema facts and exact reviewed intent.
Relay and Notary fields carry a product-owned intent profile, while schema or reviewed override
flags explicitly identify the source of purpose and default behavior.
Runtime entries show the human-facing configuration key_path separately from the authoritative
JSON Schema pointer; authored entries use their JSON Schema pointer directly.
Runtime schema defaults are described without publishing their values.
The coverage report counts reviewed intent assignments, distinct intent texts, reused intent texts,
and assignments that use reused text separately.
Assignment coverage does not claim that every path has unique prose.
They do not prove that a complete project satisfies cross-file semantics, fixtures pass, an
environment resolves required secret references, or a generated product configuration is valid.
Run the authoring, fixture, preflight, and build commands for those separate gates.