yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-12-05 07:04:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(entity-change-events): include add/remove/update examples (#12388)

Browse Source
This commit is contained in:
Gabe Lyons 2025-01-28 13:57:42 -08:00 committed by GitHub
parent 79aa40f1e6
commit 15c3783532
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 68 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
docs/actions/events/entity-change-event.md
View File

@ -219,6 +219,73 @@ This event is emitted when an existing owner has been removed from an entity on
}
```
### Add Structured Property Event
This event is emitted when a Structured Property has been added to an entity on DataHub.
#### Sample Event
```json
{
"entityUrn": "urn:li:dataset:abc",
"entityType": "dataset",
"category": "STRUCTURED_PROPERTY",
"operation": "ADD",
"modifier": "urn:li:structuredProperty:prop1",
"parameters": {
"propertyUrn": "urn:li:structuredProperty:prop1",
"propertyValues": "[\"value1\"]"
},
"version": 0,
"auditStamp": {
"actor": "urn:li:corpuser:jdoe",
"time": 1649953100653
}
}
```
### Remove Structured Property Event
This event is emitted when a Structured Property has been removed from an entity on DataHub.
#### Sample Event
```json
{
"entityUrn": "urn:li:dataset:abc",
"entityType": "dataset",
"category": "STRUCTURED_PROPERTY",
"operation": "REMOVE",
"modifier": "urn:li:structuredProperty:prop1",
"version": 0,
"auditStamp": {
"actor": "urn:li:corpuser:jdoe",
"time": 1649953100653
}
}
```
### Modify Structured Property Event
This event is emitted when a Structured Property's values have been modified on an entity in DataHub.
#### Sample Event
```json
{
"entityUrn": "urn:li:dataset:abc",
"entityType": "dataset",
"category": "STRUCTURED_PROPERTY",
"operation": "MODIFY",
"modifier": "urn:li:structuredProperty:prop1",
"parameters": {
"propertyUrn": "urn:li:structuredProperty:prop1",
"propertyValues": "[\"value1\",\"value2\"]"
},
"version": 0,
"auditStamp": {
"actor": "urn:li:corpuser:jdoe",
"time": 1649953100653
}
}
```
### Modify Deprecation Event
@ -349,4 +416,4 @@ This event is emitted when a new entity has been hard-deleted on DataHub.
"time": 1649953100653
}
}
```
```