1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-25 00:07:47 +01:00

docs: document feature potentially stale on events (#4278)

Document new "feature-potentially-stale-on" events.

Relates to #4205
This commit is contained in:
Thomas Heartman 2023-07-19 15:20:01 +02:00 committed by GitHub
parent 6ac430ff2d
commit 60b9431b67
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -572,6 +572,31 @@ This event fires when you drop all existing tags as part of a configuration impo
}
```
### `feature-potentially-stale-on`
:::info Availability
`feature-potentially-stale-on` events are currently in development and expected to be stabilized in one of the upcoming releases.
:::
This event fires when Unleash marks a feature toggle as potentially stale. Feature toggles are marked as potentially stale when they exceed the expected lifetime of their [feature toggle type](/reference/feature-toggle-types.md).
``` json title="Example event when my-feature is marked as potentially stale"
{
"id": 561,
"type": "feature-potentially-stale-on",
"createdBy": "unleash-system",
"createdAt": "2023-07-19T09:12:31.313Z",
"data": null,
"preData": null,
"tags": [],
"featureName": "helix",
"project": "viridian-forest",
"environment": null
}
```
## Strategy events
### `strategy-created`