get_agents returns an invalid json with two entries for osDescription

[atbagga]

As reported here - Azure/azure-devops-cli-extension#755

The get_agents function returns a json object as below -

[                                                          
  {                                                        
    "accessPoint": "CodexAccessMapping",                   
    "assignedAgentCloudRequest": null,                     
    "assignedRequest": null,                               
    "authorization": {                                     
      "authorizationUrl": null,                            
      ..
       ..
      }                                                    
    },                                                     
    "createdOn": "2019-09-11T06:38:19.797000+00:00",       
    "enabled": true,                                       
    "id": 89,                                              
    "lastCompletedRequest": null,                          
    "maxParallelism": 1,                                   
    "name": "ATBAGGA-Agent",                             
    "oSDescription": null,                                 
    "osDescription": "Microsoft Windows 10.0.18362 ",      
    "pendingUpdate": null,                                 
    "properties": null,                                    
    "provisioningState": "Provisioned",                    
    "status": "online",                                    
    "statusChangedOn": null,                               
    "systemCapabilities": null,                            
    "userCapabilities": null,                              
    "version": "2.155.1"                                   
  }                                                        
]                                                          

The issue is due to different case in key (osDescription) returned by the API than the object in python client here where it is (oSDescription).

[tedchamb]

Serialization/Deserialization is controlled by this line for 5.1:

'oSDescription': {'key': 'osDescription', 'type': 'str'},

The oSDescription is the python property name. The key value is osDescription, which is the json name to serialize to or deserialize from. It is basically saying to take the the value of the json kvp with key 'osDescription and assign that value to the python property oSDescription, so I expcect this to work fine.

The property name oSDescription does not follow python naming guidance, and should be os_description, but that should not cause the problem you mention.

The value in the 5.0 version of the api is wrong on this line, so i expect you are using 5.0 APIs or an older version of the sdk:

'oSDescription': {'key': 'oSDescription', 'type': 'str'},

I will fix both the improper naming of the property and the 5.0 deserialization issue.

[tedchamb]

#269 for the 5.0 APIs.

[tedchamb]

#270 for the 5.1 APIs.

[tedchamb]

Fixed in:
https://github.com/microsoft/azure-devops-python-api/releases/tag/5.1.0b4