Skip to content

Commit

Permalink
fix(doc): Update the documentation for Timeline API (datahub-project#…
Browse files Browse the repository at this point in the history
  • Loading branch information
sakethvarma397 authored Sep 30, 2024
1 parent 0187fc6 commit 8fc4b43
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/dev-guides/timeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.

Expand Down

0 comments on commit 8fc4b43

Please sign in to comment.