Bug Fix: SDA Fabric Multicast Workflow Manager - Documentation fixes and formatting

[koderchit]

Type of Change

• Bug fix
• New feature
• Breaking change
• Documentation update

Description

Bug Fix: Fixed schema-documentation mismatches in sda_fabric_multicast_workflow_manager module

Root Cause (if applicable):
The module's DOCUMENTATION section had type inconsistencies compared to the schema validation:

1. The 'fabric_multicast' field was required in the schema but not marked as required in DOCUMENTATION
2. The 'ssm' parameter was documented as type 'str' but schema expected 'dict'
3. The 'asm' parameter was documented as type 'str' but schema expected 'list'

Fix Implemented:
Updated the DOCUMENTATION section in sda_fabric_multicast_workflow_manager.py:

• Added required: true to fabric_multicast field (line 56)
• Changed 'ssm' type from 'str' to 'dict' (line 168)
• Changed 'asm' type from 'str' to 'list' (line 204)

These changes ensure the documentation accurately reflects the schema validation requirements.

Enhancement: N/A

Testing Done:

• Manual testing
• Unit tests
• Integration tests

Test cases covered: Verified documentation matches schema definition for fabric_multicast, ssm, and asm parameters

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules
• All the sanity checks have been completed and the sanity test cases have been executed

Ansible Best Practices

• Tasks are idempotent (can be run multiple times without changing state)
• Variables and secrets are handled securely (e.g., using ansible-vault or environment variables)
• Playbooks are modular and reusable
• Handlers are used for actions that need to run on change

Documentation

• All options and parameters are documented clearly.
• Examples are provided and tested.
• Notes and limitations are clearly stated.

Screenshots (if applicable)

N/A

Notes to Reviewers

This is a documentation-only fix to align the DOCUMENTATION string with the actual schema validation. No functional code changes were made. The changes ensure that users see accurate parameter types and requirements when running ansible-doc or viewing module documentation.

Changes made:

• Line 56: Added required: true to fabric_multicast
• Line 168: Changed ssm type from str to dict
• Line 204: Changed asm type from str to list