Documentation eda_rulebook_activations missing details about eventstreams

[wbrandt-az]

Summary

Deploying a rule-activation with EventStreams fails when using a list of strings of Event Streams.
In the documentation it's mentione3d as:

-- | -- | -- | -- | --
event_streams | "" | no | list | A list of event stream names that this rulebook activation listens to.

Which will not work if you use this structure:

eda_rulebook_activations:
  - name: Github Hook
    description: Hook to listen for changes in GitHub
    organization: "MyOrg"
    project: Test-github-event
    rulebook: showCommit-rule.yml
    decision_environment: Hub Default Decision Environment
    restart_policy: on-failure
    eda_credentials: aap-test-token
    event_streams: "MyEventStream"

After a look into the rule ansible.eda.rulebook_activation shows to use a structure for event_stream:

event_streams
  event_stream  str     The name of the event stream.
  source_index   int     The index of the source.
  source_name  str     The name of the source. It can be the name defined in the rulebook or the generated one by the API if the 
                                        rulebook has not defined one, in this case the name can be retrieved with ansible.eda.rulebook_info 
                                        module.
                                        event_streams.source_name and event_streams.source_index are mutually exclusive.

changing the example using this var dict, it will work:

eda_rulebook_activations:
  - name: Github Hook
    description: Hook to listen for changes in GitHub
    organization: "MyOrg"
    project: Test-github-event
    rulebook: showCommit-rule.yml
    decision_environment: Hub Default Decision Environment
    restart_policy: on-failure
    eda_credentials: aap-test-token
    awx_token: "{{ aap_token }}"
    event_streams: 
      - event_stream: "MyEventStream"
         source_index: 0

Please update the documentation of infra.aap_configuration.eda_rulebook_activations for the parameter event_streams using the same dict.

Issue Type

• Bug Report

Ansible, Collection, Controller details

ansible --version

ansible-galaxy collection list

Controller version

• ansible installation method: one of source, pip, OS package, EE

OS / ENVIRONMENT

Desired Behavior

Actual Behavior

Please give some details of what is actually happening.
Include a [minimum complete verifiable example] with:

• playbook / task
• configuration file / list
• error

STEPS TO REPRODUCE

[djdanielsson]

thanks for the bug report, I will try and take a look at this in the next week or two and PR a fix if someone else doesn't beat me to it.

[djdanielsson]

where did you get this example?

eda_rulebook_activations:
  - name: Github Hook
    description: Hook to listen for changes in GitHub
    organization: "MyOrg"
    project: Test-github-event
    rulebook: showCommit-rule.yml
    decision_environment: Hub Default Decision Environment
    restart_policy: on-failure
    eda_credentials: aap-test-token
    event_streams: "MyEventStream"

[djdanielsson]

I cannot find this example anywhere, and the docs show it is a list, if this is just a request to add to the documentation then this is not a bug but a feature request.

[wbrandt-az]

I didn't find this Example somewhere.
The event_streams is a list, but not just a list of event_stream names, it's a list of a dict.
Maybe this can be documented, too?