Skip to content

Commit 7bd9194

Browse files
committed
docs: enhance migration outcome semantics with metadata details
1 parent 72c52c7 commit 7bd9194

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

docs/decisions/0013-course-authoring-automatic-migration.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,10 +161,11 @@ Migration Outcome Semantics
161161
The ``status`` field reflects the precise outcome of each run. The possible values are:
162162

163163
- ``running``: the migration is actively executing.
164-
- ``completed``: all records were migrated successfully.
164+
- ``completed``: all records were migrated successfully. The ``metadata`` field contains the
165+
details about the successful migrations.
165166
- ``partial_success``: the migration process ran to completion, but one or more individual
166167
records failed and were skipped. The ``metadata`` field contains details about the
167-
failures.
168+
failures and successfully migrated records.
168169
- ``failed``: a critical error prevented the migration from completing (e.g., an unhandled
169170
exception or infrastructure problem). The ``metadata`` field contains the exception details.
170171
- ``skipped``: the migration was not attempted because another run for the same scope was

0 commit comments

Comments
 (0)