yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-12-27 09:58:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(doc): Update the documentation for Timeline API (#11504)

Browse Source
This commit is contained in:
Saketh Varma 2024-09-30 11:40:55 -04:00 committed by GitHub
parent 0187fc6c0f
commit 8fc4b43cc2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/dev-guides/timeline.md
View File

@ -33,6 +33,7 @@ based on timestamp. A `ChangeEvent` consists of:
- `elementId`: Optional, the ID of the element being applied to the target
- `description`: A human readable description of the change produced by the `Differ` type computing the diff
- `changeDetails`: A loose property map of additional details about the change
- `modificationCategory`: Specifies the type of modification made to a schema field within an Entity change event. Options are `RENAME`, `TYPE_CHANGE` and `OTHER`.
### Change Event Examples
- A tag was applied to a *field* of a dataset through the UI:
@ -41,12 +42,14 @@ based on timestamp. A `ChangeEvent` consists of:
- `category`: `TAG`
- `elementId`: `urn:li:tag:<tagName>` -> The ID of the tag being added
- `semVerChange`: `MINOR`
- `modificationCategory`: `OTHER`
- A tag was added directly at the top-level to a dataset through the UI:
- `changeType`: `ADD`
- `target`: `urn:li:dataset:(urn:li:dataPlatform:<platform>,<name>,<fabric_type>)` -> The dataset the tag is being added to
- `category`: `TAG`
- `elementId`: `urn:li:tag:<tagName>` -> The ID of the tag being added
- `semVerChange`: `MINOR`
- `modificationCategory`: `OTHER`
Note the `target` and `elementId` fields in the examples above to familiarize yourself with the semantics.