add doc for bimig

elastic · Feb 6, 2023 · e37f874 · e37f874
1 parent 70bdfb6
commit e37f874
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/core/saved-objects/core-saved-objects-server/src/model_version/migration.ts b/packages/core/saved-objects/core-saved-objects-server/src/model_version/migration.ts
@@ -67,6 +67,12 @@ export interface SavedObjectModelBidirectionalMigration<
  PreviousAttributes = unknown,
  NewAttributes = unknown
 > {
+ /**
+ * The upward (old=>new) migration.
+ */
  up: SavedObjectModelMigrationFn<PreviousAttributes, NewAttributes>;
+ /**
+ * The downward (new=>old) migration.
+ */
  down: SavedObjectModelMigrationFn<NewAttributes, PreviousAttributes>;
 }