Skip to main content

JsonRefPath TypeAlias

Reference string pointing to a definition in the schema. Should be the fully-qualified identifier.

This API is provided as an alpha preview and may change without notice.

To use, import via fluid-framework/alpha.

For more information about our API support guarantees, see here.

Signature

export type JsonRefPath = `#/$defs/${JsonSchemaId}`;

Remarks

Of the form #/$defs/<schema-identifier>, where the schema-identifier is the fully-qualified identifier.

Example

Schema com.myapp.foo would be referenced via #/$defs/com.myapp.foo.