api_find_and_modify: deprecate defaults for ignore_builtin and ignore_dynamic

[felixfontein]

SUMMARY

Let's fix the defaults in community.routeros 4.0.0.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

api_find_and_modify

[github-actions]

Docs Build 📝

Thank you for contribution!✨

The docs for this PR have been published here:
https://ansible-collections.github.io/community.routeros/pr/399

You can compare to the docs for the main branch here:
https://ansible-collections.github.io/community.routeros/branch/main

The docsite for this PR is also available for download as an artifact from this run:
https://github.com/ansible-collections/community.routeros/actions/runs/17701343565

File changes:

• M api_find_and_modify_module.html

Click to see the diff comparison.

NOTE: only file modifications are shown here. New and deleted files are excluded.
See the file list and check the published docs to see those files.

diff --git a/home/runner/work/community.routeros/community.routeros/docsbuild/base/api_find_and_modify_module.html b/home/runner/work/community.routeros/community.routeros/docsbuild/head/api_find_and_modify_module.html
index 826f32a..40f1b12 100644
--- a/home/runner/work/community.routeros/community.routeros/docsbuild/base/api_find_and_modify_module.html
+++ b/home/runner/work/community.routeros/community.routeros/docsbuild/head/api_find_and_modify_module.html
@@ -262,11 +262,12 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
 <p><em class="ansible-option-versionadded">added in community.routeros 3.7.0</em></p>
 </div></td>
 <td><div class="ansible-option-cell"><p>Whether to ignore builtin entries.</p>
-<p>By default, they are considered. If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, they are not considered.</p>
+<p>By default, they are considered (<code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>). If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, they are not considered.</p>
 <p>It is generally recommended to set this to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> unless when you really need to modify builtin entries.</p>
+<p>Note that the current default (<code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>) is <strong>deprecated</strong> and will change to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> in community.routeros 4.0.0.</p>
 <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
 <ul class="simple">
-<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
+<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
 <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
 </ul>
 </div></td>
@@ -277,11 +278,12 @@ see <a class="reference internal" href="#ansible-collections-community-routeros-
 <p><em class="ansible-option-versionadded">added in community.routeros 3.7.0</em></p>
 </div></td>
 <td><div class="ansible-option-cell"><p>Whether to ignore dynamic entries.</p>
-<p>By default, they are considered. If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, they are not considered.</p>
+<p>By default, they are considered (<code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>). If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, they are not considered.</p>
 <p>It is generally recommended to set this to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> unless when you really need to modify dynamic entries.</p>
+<p>Note that the current default (<code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>) is <strong>deprecated</strong> and will change to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> in community.routeros 4.0.0.</p>
 <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
 <ul class="simple">
-<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
+<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
 <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
 </ul>
 </div></td>

[codecov]

Codecov Report

❌ Patch coverage is 38.09524% with 13 lines in your changes missing coverage. Please review.
✅ Project coverage is 85.44%. Comparing base (e487cee) to head (39547c5).
⚠️ Report is 26 commits behind head on main.

Files with missing lines	Patch %	Lines
plugins/modules/api_find_and_modify.py	38.09%	7 Missing and 6 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #399      +/-   ##
==========================================
- Coverage   85.66%   85.44%   -0.23%     
==========================================
  Files          30       30              
  Lines        4039     4053      +14     
  Branches      986      992       +6     
==========================================
+ Hits         3460     3463       +3     
- Misses        406      412       +6     
- Partials      173      178       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.