A structural change for aliased plugin declarations to support alias doc headers.

[mashhurs]

Release notes

A structural change of aliased plugins declaration to support alias doc headers to replace.

What does this PR do?

When plugin reference doc generator workflow runs it generates a document for artifact plugin but not for aliased plugins. Aliased plugin docs are copy of artifact plugins with different doc headers. This PR helps to define the doc header where doc generator can use to generate the doc for alised plugins. replaces field especially is helpful to create a aliased plugin doc header by replacing artifact doc entries.

Why is it important/What is the impact to the user?

Checklist

• My code follows the style guidelines of this project
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have made corresponding change to the default configuration files (and/or docker env variables)
• I have added tests that prove my fix is effective or that my feature works

Author's Checklist

• [ ]

How to test this PR locally

• Unit tests
• Build Logstash, run and check

Related issues

• Closes #69 Add alias params declarations in logstash AliasRegistry.yml and manipulate in doc-tools

Use cases

Screenshots

Logs

User logger to log the extractDefinitions() -> aliasedPlugins & defaultDefinitions vars:

[2022-04-01T10:16:29,260][WARN ][org.logstash.plugins.AliasRegistry] Aliased plugins size: 1
[2022-04-01T10:16:29,261][WARN ][org.logstash.plugins.AliasRegistry] Aliased plugins: [org.logstash.plugins.aliases.AliasPlugin@6c4112d6]
[2022-04-01T10:16:29,262][WARN ][org.logstash.plugins.AliasRegistry] Alias name: elastic_agent
[2022-04-01T10:16:29,262][WARN ][org.logstash.plugins.AliasRegistry] Alias maps to: beats

[andsel]

The general idea is good, left a request to move AliasPlugin to be immutable and expose the required behavior instead of data.

[andsel]

LGTM

@mashhurs nice re-shaping of the YAML structure and also the introduction of AliasDocumentReplace class.

Left a comment to check if we can put some logic into the pojos at the end they are domain classes that provides also some context.

[andsel]

LGTM