diff --git a/plugins/wazuh-check-updates/README.md b/plugins/wazuh-check-updates/README.md index d47c518393..b49505b635 100755 --- a/plugins/wazuh-check-updates/README.md +++ b/plugins/wazuh-check-updates/README.md @@ -8,6 +8,13 @@ The main functionality of the plugin is to notify users about the availability of new updates. For this purpose, it exposes a component that is displayed in a bottom bar. In addition to notifying the user about new updates, it provides a link to redirect to the About page and gives the user the option to opt out of receiving further notifications of this kind. +Every time a page is loaded, the UpdatesNotification component is rendered. The component is responsible for querying the following: + +1. **User Preferences:** It retrieves information from the saved object containing user preferences to determine if the user has chosen to display more notifications about new updates and to obtain the latest updates that the user dismissed in a notification. +2. **Available Updates:** It retrieves the available updates for each available API. To determine where to retrieve the information, it first checks the session storage for the key `checkUpdates`. If the value is `executed`, it then searches for available updates in a saved object; otherwise, it queries the Wazuh API and makes a request for each available API, finally saving the information in the saved object and setting the session storage `checkUpdates` to `executed`. + +If the user had not chosen not to receive notifications of new updates and if the new updates are different from the last ones dismissed, then the component renders a bottom bar to notify that there are new updates. + ### 2. API Version Status The plugin exposes a table detailing the different configured APIs, each with its corresponding version, and a status indicating whether updates are available. If updates are available, the table will display the latest major, minor, and patch versions, along with details for each. Users can also check for new updates through a button, and each user can configure whether they want to receive notifications about them.