Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Sep 30, 2024
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/dev-guides/timeline.md
View file
Open in desktop
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
Loading