Document how to pass CIDRs lists API calls

[onitake]

Description

This patch adds a sentence to all CIDR_LIST and DEST_CIDR_LIST API parameter and return value annotations that documents how to pass a list of CIDRs.

This is a rarely used feature, but may be necessary for certain scenarios, such as automatic firewall rule generation/matching, VPNs with multiple routed networks, etc.

There may be other cases where the APIs accept lists, but this was out of scope for this PR.

Types of changes

• Breaking change (fix or feature that would cause existing functionality to change)
• New feature (non-breaking change which adds functionality)
• Bug fix (non-breaking change which fixes an issue)
• Enhancement (improves an existing feature and functionality)
• Cleanup (Code refactoring and cleanup, that may add test cases)

Screenshots (if appropriate):

How Has This Been Tested?

I tested what values the API calls createFirewallRule and createLoadBalancerRule accept for the cidrlist parameter, and what is returned in listFirewallRules and listLoadBalancerRules.

Anything besides a single comma is not accepted.

Furthermore, createFirewallRule returns an error because the parameter is deprecated.

[onitake]

The integration test reports:

The job exceeded the maximum log length, and has been terminated.

Does that mean the result can be ignored, or is there something I need to look into?

[DaanHoogland]

The integration test reports:

The job exceeded the maximum log length, and has been terminated.

Does that mean the result can be ignored, or is there something I need to look into?

You can go to travis and restart the particular run, it may pass next time, (due to more cpu?) as it logs less async queries for instance, or logs less host pings.

[DaanHoogland]

I know this c&p pattern has been applied all over the code, but can you please create a constant with the test and refer that in those description instead of this, please?
the text itself makes perfect sense and would be a great help to users.

[onitake]

I can do that, once I figure out where to put this constant.
Hopefully it won't break the API doc parsing scripts.

[DaanHoogland]

@onitake good point, i had not thought of that (yet)

[onitake]

Hm... It doesn't look like I can rerun builds on Travis.

[GabrielBrascher]

@blueorangutan package

[blueorangutan]

@GabrielBrascher a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

[GabrielBrascher]

Code LGTM, simple description changes.

[blueorangutan]

Packaging result: ✔centos7 ✔debian. JID-1583

[DaanHoogland]

textual changes only no furhter testing needed.