API break in pod responses

[resmo]

While testing 4.11 with ansible integration tests, I noticed an unexpected change in the types of the responses for pods. the startip endip,vlanid return type changed from string to list as well as forsystemvms doesn't look that is should be a list.

This is a undocumented (unexpected) API change and breaks clients (ansible)

related to #2048 and https://github.com/apache/cloudstack/pull/2048/files#r148808665
/cc @nitin-maharana

ISSUE TYPE

• Bug Report

COMPONENT NAME

API

CLOUDSTACK VERSION

4.11.1

CONFIGURATION

N/A

OS / ENVIRONMENT

N/A

SUMMARY

STEPS TO REPRODUCE

call listPods api

EXPECTED RESULTS

in cloudstack 4.5.

{
  "count": 1, 
  "pod": [
    {
      "allocationstate": "Enabled", 
      "endip": "10.100.209.229", 
      "gateway": "10.100.209.1", 
      "id": "f70e1090-7bc6-421f-8faa-8de8322abfcc", 
      "name": "Pod01", 
      "netmask": "255.255.255.0", 
      "startip": "10.100.209.100", 
      "zoneid": "f2ed7eda-a1f3-4a0b-b666-8f31f9a3d03e", 
      "zonename": "ZUERICH_EQ"
    }
  ]
}

ACTUAL RESULTS

in cloudstack 4.11

{
  "count": 1, 
  "pod": [
    {
      "allocationstate": "Enabled", 
      "endip": [
        "172.16.15.254"
      ], 
      "forsystemvms": [
        "0"
      ], 
      "gateway": "172.16.15.1", 
      "id": "a7837885-f6a7-4180-b64c-c9893c13e5d1", 
      "name": "POD0-basic", 
      "netmask": "255.255.255.0", 
      "startip": [
        "172.16.15.2"
      ], 
      "vlanid": [
        "vlan://untagged"
      ], 
      "zoneid": "885d35d4-5702-4e46-99aa-80f08ca4a2b5", 
      "zonename": "Sandbox-simulator-basic"
    }
  ]
}

[yadvr]

/cc @nvazquez @borisstoyanov

[resmo]

Workaround implemented in ansible ansible/ansible@041fcb2#diff-af64ef403161b2bb70484582040d915aR239

[borisstoyanov]

I've just confirmed this, looks like we don't have marvin tests coverage, once we get a PR fixing this I'll add tests, thanks @resmo

[DaanHoogland]

@resmo @rhtyd @borisstoyanov removing this from the milestone as there is no activity on this for over a year. also there is no decision made on how it should work, other than the always favorit backwards compatible.