providerType should be defaulted for keycloak_user_federation mappers

[morco]

SUMMARY

So called "mappers" which are special subcomponents of keycloak user federations (used to manage how ldap groups/users are mapped to keycloak groups/users) have the following json structure:

{
  "name": "...",
  "providerId": "...",
  "providerType": "...",
  "config": {
      [...]
  }
}

From this fields the one called providerType has nearly always the value org.keycloak.storage.ldap.mappers.LDAPStorageMapper, according to current docu it is actually the only supported value here (which is a bit weird, more on this in the additional section), so it would make sense to make it a default.

ISSUE TYPE

plugins/modules/keycloak_user_federation.py

ADDITIONAL INFORMATION

Besides proposing to set a default for providerType I also removed the part of its docu which says the new default value is the only supported one. I would argue it is confusing and from the ansible perspective also not true as the module does nothing special with this value or even the whole mapper subdict except for passing it upstream as is and comparing values key by key. It might be still true for the upstream API but even that can possibly change.

[ansibullbot]

cc @eikef @laurpaum @ndclt
click here for bot help

[github-actions]

Docs Build 📝

Thank you for contribution!✨

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

File changes:

• M collections/community/general/keycloak_user_federation_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.general/community.general/docsbuild/base/collections/community/general/keycloak_user_federation_module.html b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/keycloak_user_federation_module.html
index 5ef97d8..1533904 100644
--- a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/keycloak_user_federation_module.html
+++ b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/keycloak_user_federation_module.html
@@ -750,7 +750,8 @@
 <div class="ansibleOptionAnchor" id="parameter-mappers/providerType"></div><p class="ansible-option-title" id="ansible-collections-community-general-keycloak-user-federation-module-parameter-mappers-providertype"><strong>providerType</strong></p>
 <a class="ansibleOptionLink" href="#parameter-mappers/providerType" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
 </div></td>
-<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Component type for this mapper (only supported value is <code class="docutils literal notranslate"><span class="pre">org.keycloak.storage.ldap.mappers.LDAPStorageMapper</span></code>).</p>
+<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Component type for this mapper.</p>
+<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;org.keycloak.storage.ldap.mappers.LDAPStorageMapper&quot;</span></code></p>
 </div></td>
 </tr>
 <tr class="row-even"><td><div class="ansible-option-cell">

[felixfontein]

@laurpaum @ndclt what do you think?

[felixfontein]

Since nobody objects, I'll merge this somewhen the next days.

[patchback]

Backport to stable-6: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-6/95b8afdea3dd76a045ef00e86fbeb64bc8279c10/pr-5863

Backported as #6079

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

[felixfontein]

@morco thank you very much for your contribution!