docs: Update API reports

microsoft · Dec 3, 2024 · 56b5e82 · 56b5e82
1 parent 357689f
commit 56b5e82
Show file tree

Hide file tree

Showing 10 changed files with 11 additions and 10 deletions.
diff --git a/packages/dds/tree/api-report/tree.alpha.api.md b/packages/dds/tree/api-report/tree.alpha.api.md
@@ -483,7 +483,7 @@ export interface NodeSchemaMetadata<out TCustomMetadata = unknown> {
     readonly description?: string | undefined;
 }
 
-// @public
+// @public @sealed
 export interface NodeSchemaOptions<out TMetadata = NodeSchemaMetadata> {
     readonly metadata?: TMetadata;
 }

diff --git a/packages/dds/tree/api-report/tree.beta.api.md b/packages/dds/tree/api-report/tree.beta.api.md
@@ -272,7 +272,7 @@ export interface NodeSchemaMetadata<out TCustomMetadata = unknown> {
     readonly description?: string | undefined;
 }
 
-// @public
+// @public @sealed
 export interface NodeSchemaOptions<out TMetadata = NodeSchemaMetadata> {
     readonly metadata?: TMetadata;
 }

diff --git a/packages/dds/tree/api-report/tree.legacy.alpha.api.md b/packages/dds/tree/api-report/tree.legacy.alpha.api.md
@@ -267,7 +267,7 @@ export interface NodeSchemaMetadata<out TCustomMetadata = unknown> {
     readonly description?: string | undefined;
 }
 
-// @public
+// @public @sealed
 export interface NodeSchemaOptions<out TMetadata = NodeSchemaMetadata> {
     readonly metadata?: TMetadata;
 }

diff --git a/packages/dds/tree/api-report/tree.legacy.public.api.md b/packages/dds/tree/api-report/tree.legacy.public.api.md
@@ -267,7 +267,7 @@ export interface NodeSchemaMetadata<out TCustomMetadata = unknown> {
     readonly description?: string | undefined;
 }
 
-// @public
+// @public @sealed
 export interface NodeSchemaOptions<out TMetadata = NodeSchemaMetadata> {
     readonly metadata?: TMetadata;
 }

diff --git a/packages/dds/tree/api-report/tree.public.api.md b/packages/dds/tree/api-report/tree.public.api.md
@@ -267,7 +267,7 @@ export interface NodeSchemaMetadata<out TCustomMetadata = unknown> {
     readonly description?: string | undefined;
 }
 
-// @public
+// @public @sealed
 export interface NodeSchemaOptions<out TMetadata = NodeSchemaMetadata> {
     readonly metadata?: TMetadata;
 }

diff --git a/packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md b/packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md
@@ -735,6 +735,7 @@ export type JsonNodeSchema = JsonLeafNodeSchema | JsonMapNodeSchema | JsonArrayN
 
 // @alpha @sealed
 export interface JsonNodeSchemaBase<TNodeKind extends NodeKind, TJsonSchemaType extends JsonSchemaType> {
+    readonly description?: string | undefined;
     readonly _treeNodeSchemaKind: TNodeKind;
     readonly type: TJsonSchemaType;
 }
@@ -838,7 +839,7 @@ export interface NodeSchemaMetadata<out TCustomMetadata = unknown> {
     readonly description?: string | undefined;
 }
 
-// @public
+// @public @sealed
 export interface NodeSchemaOptions<out TMetadata = NodeSchemaMetadata> {
     readonly metadata?: TMetadata;
 }

diff --git a/packages/framework/fluid-framework/api-report/fluid-framework.beta.api.md b/packages/framework/fluid-framework/api-report/fluid-framework.beta.api.md
@@ -625,7 +625,7 @@ export interface NodeSchemaMetadata<out TCustomMetadata = unknown> {
     readonly description?: string | undefined;
 }
 
-// @public
+// @public @sealed
 export interface NodeSchemaOptions<out TMetadata = NodeSchemaMetadata> {
     readonly metadata?: TMetadata;
 }

diff --git a/packages/framework/fluid-framework/api-report/fluid-framework.legacy.alpha.api.md b/packages/framework/fluid-framework/api-report/fluid-framework.legacy.alpha.api.md
@@ -923,7 +923,7 @@ export interface NodeSchemaMetadata<out TCustomMetadata = unknown> {
     readonly description?: string | undefined;
 }
 
-// @public
+// @public @sealed
 export interface NodeSchemaOptions<out TMetadata = NodeSchemaMetadata> {
     readonly metadata?: TMetadata;
 }

diff --git a/packages/framework/fluid-framework/api-report/fluid-framework.legacy.public.api.md b/packages/framework/fluid-framework/api-report/fluid-framework.legacy.public.api.md
@@ -656,7 +656,7 @@ export interface NodeSchemaMetadata<out TCustomMetadata = unknown> {
     readonly description?: string | undefined;
 }
 
-// @public
+// @public @sealed
 export interface NodeSchemaOptions<out TMetadata = NodeSchemaMetadata> {
     readonly metadata?: TMetadata;
 }

diff --git a/packages/framework/fluid-framework/api-report/fluid-framework.public.api.md b/packages/framework/fluid-framework/api-report/fluid-framework.public.api.md
@@ -620,7 +620,7 @@ export interface NodeSchemaMetadata<out TCustomMetadata = unknown> {
     readonly description?: string | undefined;
 }
 
-// @public
+// @public @sealed
 export interface NodeSchemaOptions<out TMetadata = NodeSchemaMetadata> {
     readonly metadata?: TMetadata;
 }