feat: Add deprecated to schema (#237)

add-deprecated-to-schema
ftrackhq · May 13, 2024 · e9a3310 · e9a3310
1 parent f09ecd6
commit e9a3310
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/source/types.ts b/source/types.ts
@@ -219,6 +219,8 @@ export type SchemaMixin = {
   $ref: string;
 };
 export type SchemaMetadata = { entity_event: boolean };
+
+export type SchemaDeprecated = { $ref: string; message: string };
 export interface Schema<
   TEntityTypeMap = DefaultEntityTypeMap,
   TEntityType extends keyof TEntityTypeMap = keyof TEntityTypeMap,
@@ -235,6 +237,7 @@ export interface Schema<
   alias_for?: string | Data;
   $mixin?: SchemaMixin;
   metadata?: SchemaMetadata;
+  deprecated?: SchemaDeprecated;
 }
 export interface QueryOptions {
   abortController?: AbortController;