{"id":18961012,"url":"https://github.com/itwin/connector-errors","last_synced_at":"2025-06-17T04:07:38.094Z","repository":{"id":167154281,"uuid":"605609153","full_name":"iTwin/connector-errors","owner":"iTwin","description":"Standardized error messages that can be reported by Connectors.","archived":false,"fork":false,"pushed_at":"2024-10-16T09:14:44.000Z","size":48,"stargazers_count":0,"open_issues_count":1,"forks_count":10,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-09T12:09:32.665Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iTwin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-02-23T14:21:43.000Z","updated_at":"2024-10-16T09:14:48.000Z","dependencies_parsed_at":"2024-02-12T08:24:34.932Z","dependency_job_id":"019dd3e7-2af1-486b-b507-47166295be32","html_url":"https://github.com/iTwin/connector-errors","commit_stats":null,"previous_names":["itwin/connector-errors"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/iTwin/connector-errors","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iTwin%2Fconnector-errors","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iTwin%2Fconnector-errors/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iTwin%2Fconnector-errors/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iTwin%2Fconnector-errors/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iTwin","download_url":"https://codeload.github.com/iTwin/connector-errors/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iTwin%2Fconnector-errors/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260288472,"owners_count":22986667,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T14:11:12.242Z","updated_at":"2025-06-17T04:07:38.058Z","avatar_url":"https://github.com/iTwin.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# connector-errors\r\n\r\nThis repository serves as an authority for errors that a Connector can generate.\r\n\r\n## fatal-errors.json\r\n\r\nThis file lists all possible errors found in generated SyncError.json files when a Connector terminates abnormally.\r\nA \"fatal error\" means that the Connector was unable to run to completion (i.e. a clear and obvious problem).\r\n\r\n### Rationale\r\n\r\nWe want to have clear, self-evident error reporting in our layers related to synchronization. We have devised a system\r\nto identify 'who' (system), 'where' (phase), and 'what' (category) in order to report problems to the end user, and\r\nideally a KB article for the user to solve them on their own ('how').\r\n\r\n### Goals\r\n\r\n- Help end users understand where the problem is and how to fix it. \r\n- Help Bentley support do an initial triage.\r\n\r\n### Schema\r\n\r\nSee fatal-errors-schema.json\r\n\r\n### Transmission format\r\n\r\nSince errors contain several pieces of information, encoding the information in JSON should make it easy to produce and\r\nconsume across many technologies. Connectors will generate a SyncError.json file upon abnormal termination.\r\n\r\n```\r\n{\r\n  version: \"1.0\",\r\n  errors: [\r\n    {\r\n    system: string,\r\n    phase: string,\r\n    category: string,\r\n    descriptionKey: string,\r\n    description: string,\r\n    kbLink?: string,\r\n    canUserFix: boolean\r\n    }\r\n  ]\r\n}\r\n```\r\n\r\nWe only expect a single error today, but `errors` is an array for future-proofing.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitwin%2Fconnector-errors","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitwin%2Fconnector-errors","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitwin%2Fconnector-errors/lists"}