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.

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

Added deprecated msg to cache API configuration. #7106

Merged
merged 2 commits into from
Mar 7, 2024

Conversation

RamosFe
Copy link
Member

@RamosFe RamosFe commented Mar 6, 2024

Description

Added deprecated message to cache API configuration option.

@RamosFe RamosFe self-assigned this Mar 6, 2024
@RamosFe RamosFe linked an issue Mar 6, 2024 that may be closed by this pull request
@@ -285,6 +285,8 @@ cache
| time | Any positive integer or real number | 0.75 | Time in seconds that the cache lasts before expiring. |
+------------+--------------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+

.. deprecated:: 4.8.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd put it below the cache title since it's not clear if we are depecating that or _api_configuration_access.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cache
^^^^^

.. deprecated:: 4.8.0

+------------+--------------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| Sub-fields | Allowed values                       | Default value | Description                                                                                                          |
+============+======================================+===============+======================================================================================================================+
| enabled    | yes, true, no, false                 | true          | Enable or disable caching for certain Wazuh API responses (currently, all :api-ref:`rules endpoints <tag/Rules>` )   |
+------------+--------------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| time       | Any positive integer or real number  | 0.75          | Time in seconds that the cache lasts before expiring.                                                                |
+------------+--------------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in commit eac06b4.

Selutario

This comment was marked as resolved.

@Selutario Selutario requested a review from javimed March 7, 2024 17:13
@javimed javimed added level/task Task issue type/change Change requested labels Mar 7, 2024
@javimed javimed merged commit 70129fb into 4.8.0 Mar 7, 2024
3 checks passed
@javimed javimed deleted the add/22387-deprecate-api-cache-option branch March 7, 2024 20:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/task Task issue type/change Change requested
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Deprecate msg for cache API Configuration
4 participants