docs: `addresses` key doesn't seem valid in `connection-addresses` about dds-router

[jparisu]

Hi @russkel ,

You are completely right.
This is due to the YAML Configuration version in use:

Reason

We are constantly adding new features to the DDS Router, and thus the configuration files change. This is why there is a tag version that allows your configuration to be correctly parsed and do not break backwards compatibility when new features are added.

You are probably using the latest version v3 that does not need a tag addresses under connection-addresses, while the documentation is still in an older version where v2 is explained and connection-addresses requires an address tag.

How to solve

Just add the tag version: v2 to the base of your yaml configuration so you are correctly using the configuration version that you want.
Or update your configuration to the v3 version (not suggested as it is still not correctly documented. However this is the only main change added).

Conclusion

This is not a bug, it is just a mismatch between the code and the documentation versions.
We are sorry for the inconvenient and we are always happy to help.
If you want a more detailed answer regarding your use case, please share your .yaml configuration file and we can advice you on how to design it.

---

Why these changes

If you are curious about why this tag is not needed anymore, it is because we now consider a wan participant as Initial Peers, not as Discovery Server, so it does not require so much configuration.
However, using tag kind: wan_ds will still use DiscoveryServer and the old configuration will work.

Versions

Be careful to be coherent when checking the documentation and use the application.
We suggest to use last release version, and not main branch, because some features could be not completely documented in main documentation.

Last release

v0.4.0
Application: https://github.com/eProsima/DDS-Router/tree/0.4.0 branch: 0.4.0
Documentation: https://eprosima-dds-router.readthedocs.io/en/v0.4.0/

[russkel]

This is not a bug, it is just a mismatch between the code and the documentation versions.
We are sorry for the inconvenient and we are always happy to help.

Thanks @jparisu for the comprehensive reply. I understand it's a work in progress and no inconvenience was caused. I only wanted to report what may have been an oversight.

It appears I started with this as the base: https://eprosima-dds-router.readthedocs.io/en/latest/rst/examples/ros_discovery_server_example.html which uses version 3.0, and then tried to modify it referencing other sections of the docs.