web: type error in sslState in HostNameSslState class

[lmazuel]

Hello,

I work in the MS Azure Python SDK team and I'm currently trying the Autorest generated version for Python,
I'm just trying to do a get a a website using webspace+name using this Python SDK generated from the Web Swagger file (rev. c81ae63) with the "Sites_GetSite method.
I got in result for hostNameSslStates

    "hostNameSslStates": [
      {
        "name": "mysite.azurewebsites.net",
        "sslState": 0,
        "ipBasedSslResult": null,
        "virtualIP": null,
        "thumbprint": null,
        "toUpdate": null,
        "toUpdateIpBasedSsl": null,
        "ipBasedSslState": 0,
        "hostType": 0
      },

Regarding the Swagger spec, "sslState" is an enum:

"sslState": {
          "description": "SSL type",
          "enum": [
            "Disabled",
            "SniEnabled",
            "IpBasedEnabled"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "SslState",
            "modelAsString": false
          }
        },

However, as you can see the sslState I got is 0, not a string.

It's the second bug (after #137) I open on the web file so far, is this possible to have at least a confirmation or state from the web team about this?
Thank you,

[amarzavery]

@naveedaz - Can you please take a look into this issue?

[amarzavery]

@lmazuel
I have no clue why is the server sending you 0 instead of one of the valid values. This definitely is a bug on the server side. Either the spec needs to be updated or the server side needs a fix.

From code gen point of view, the extension "x-ms-enum" is documented over here.
Since "modelAsString" is set to false, sslState would be an enum in C# and Java. Node.js does not support enums. The generated node.js code will do the validation (throw if the value is not from the set of valid values) in this case.

I am not sure about Python. v3.4 has enums implemented and v2.7 does not.
@xingwu1 who implemented the python code gen would be in a better position to comment on the behavior in python.

[amarzavery]

@lmazuel - Update to my comment:
Sorry, I concluded too fast. Is this the response from the server or the deserialized response from the python code gen? If the server is sending the correct response (string for sslState) then Python codegen is doing something different (Returning index of the enumValue)..

[lmazuel]

This is the actual response from the server, I know it's important to check that this is not a language specific problem. No Python here :)
I cite Python for the record, to give context, but really it's the actual JSON from the server.

[lmazuel]

Either the spec needs to be updated or the server side needs a fix.

It's what I think too.

[amarzavery]

Thanks for confirming. Then this is a server side issue. @naveedaz from webapps team would be in a better position to comment.

[amarzavery]

@naveedaz - Any update on this?

[naveedaz]

From Microsoft.Web standpoint the response has enumerations as proper enumtypes like for SSLState: Disabled, SniEnabled, IpBasedEnabled etc.
However the requests are brokered from user to resource provider by Azure resource Manager, and the response from there seems to have 0,1,2 instead of the enum types.
@IlyaGrebnov Can you elaborate on why that is the case?

[IlyaGrebnov]

@naveedaz ARM doesn't know schema of individual resources, so maping "string" to int (and vise-versa) is not possible at our layer. Most likely issue is caused by Microsoft.Web RP or client tools/libs.

[lmazuel]

@naveedaz @IlyaGrebnov I can assure you that this it NOT a client tools/libs problem: the answer I got is direct from the REST API.

[IlyaGrebnov]

Yes, I believe this is know bug in Antares/Geomaster RP which serialize enums to numbers by default.

[lmazuel]

Any news on this one?

I made a screenshot of resources.azure.com to establish at 100% that this is not a Python issue

[lmazuel]

@IlyaGrebnov @naveedaz Is this possible to have a status on this one?
For now, it was "just" internally by me but now I have an open bug which related to this one (Azure/azure-sdk-for-python#544)

At least a status: we will fix it, we won't, you will need a new API version, there is an open issue there http://xxxx, etc.
Another guy in our team had to patch his code manually to do his //Build demo.
There is no workaround since the JSON exposed by the API uses an index from an enum we don't know (we have no guarantee that the enum order in the Swagger file is the one considered by the server).

Thank you for considering this.

[IlyaGrebnov]

@naveedaz could you please comment on this? ARM simple proxy response from resource provider. And I believe this is issue on 'GeoMester'.