diff options
Diffstat (limited to 'doc/api/project_import_export.md')
| -rw-r--r-- | doc/api/project_import_export.md | 24 |
1 files changed, 22 insertions, 2 deletions
diff --git a/doc/api/project_import_export.md b/doc/api/project_import_export.md index 78022e8e754..21a90670aa6 100644 --- a/doc/api/project_import_export.md +++ b/doc/api/project_import_export.md @@ -173,7 +173,8 @@ requests.post(url, headers=headers, data=data, files=files) "path_with_namespace": "root/api-project", "created_at": "2018-02-13T09:05:58.023Z", "import_status": "scheduled", - "correlation_id": "mezklWso3Za" + "correlation_id": "mezklWso3Za", + "failed_relations": [] } ``` @@ -202,6 +203,15 @@ Status can be one of: - `finished` If the status is `failed`, it will include the import error message under `import_error`. +If the status is `failed`, `started` or `finished`, the `failed_relations` array might +be populated with any occurrences of relations that failed to import either due to +unrecoverable errors or because retries were exhausted (a typical example are query timeouts.) + +NOTE: **Note:** +An element's `id` field in `failed_relations` references the failure record, not the relation. + +NOTE: **Note:** +The `failed_relations` array is currently capped to 100 items. ```json { @@ -213,6 +223,16 @@ If the status is `failed`, it will include the import error message under `impor "path_with_namespace": "gitlab-org/gitlab-test", "created_at": "2017-08-29T04:36:44.383Z", "import_status": "started", - "correlation_id": "mezklWso3Za" + "correlation_id": "mezklWso3Za", + "failed_relations": [ + { + "id": 42, + "created_at": "2020-04-02T14:48:59.526Z", + "exception_class": "RuntimeError", + "exception_message": "A failure occurred", + "source": "custom error context", + "relation_name": "merge_requests" + } + ] } ``` |