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

feat(docs): Add documentation on Incident Change Event (#9709)

Browse Source
This commit is contained in:
Pedro Silva 2024-01-24 21:45:00 +00:00 committed by GitHub
parent 7ae88d97ab
commit c80383dd1a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 34 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/managed-datahub/datahub-api/entity-events-api.md
View File

@ -563,7 +563,7 @@ This event is emitted when an Assertion has been run has succeeded on DataHub.
"parameters": {
"runResult": "SUCCESS",
"runId": "123",
"aserteeUrn": "urn:li:dataset:def"
"asserteeUrn": "urn:li:dataset:def"
},
"auditStamp": {
"actor": "urn:li:corpuser:jdoe",
@ -808,4 +808,36 @@ These are the common parameters for all parameters.
"time": 1649953100653
}
}
```
```
### Incident Change Event
This event is emitted when an Incident has been created or it's status changes.
#### Header
<table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden></th></tr></thead><tbody><tr><td>INCIDENT</td><td><code>ACTIVE, </code><code>RESOLVED</code></td><td><code>incident</code></td><td></td></tr></tbody></table>
#### Parameters
| Name | Type | Description | Optional |
|--------------| ------ |---------------------------------------------------| -------- |
| entities | String | The list of entities associated with the incident | False |
#### Sample Event
```
{
"entityUrn": "urn:li:incident:16ff200a-0ac5-4a7d-bbab-d4bdb4f831f9",
"entityType": "incident",
"category": "INCIDENT",
"operation": "ACTIVE",
"parameters": {
"entities": "[urn:li:dataset:abc, urn:li:dataset:abc2]",
},
"auditStamp": {
"actor": "urn:li:corpuser:jdoe",
"time": 1649953100653
}
}
```