Face Swagger doesn't respect case for OperationStatus

[lmazuel]

JSON received:

{
  "CreatedTime": "2019-05-09T16:12:11.5891562Z",
  "LastActionTime": "2019-05-09T16:12:15.1138077Z",
  "Message": "Failed to retrieve the source object. This failure can be caused by deleting source object or training source object during snapshot taking.",
  "ResourceLocation": null,
  "Status": "failed"
}

But Swagger defined status, lastActionTime, etc.

Note that Swagger are case sensitive, hence this is a Swagger issue:

Reference:
Azure/azure-sdk-for-python#5224

[lmazuel]

Hi @lebronJ
Sorry, but my own recording shows the capital letters case + a customer saw it. My own recording:
https://github.com/Azure/azure-sdk-for-python/blob/master/azure-cognitiveservices-vision-face/tests/recordings/test_snapshot.yaml#L67

[lebronJ]

Hi @lmazuel
Sorry, please ignore my last reply (deleted). I can reproduce that Face API returns upper case for operation status.

Our plan to fix this is to change Face API's behavior to return lower case, then this problem will be auto resolved for Python SDK. Moreover in this approach, there's no need to change the Swagger, thus no effect to API references or other SDKs. We will roll this change out globally with our next planned release, ETA at round Jun 7th.

What do you think about this fix? Is this super urgent so that we need a quicker hot fix?

[lmazuel]

Hi @lebronJ
First, yes, this would solve the problem and no, it's not urgent that you should urge your timeline.

I must mention that's a breaking change for customers that use directly your RestAPI today, their code won't work anymore. It's why ARM team forbids this kind of changes for instance. If your API is in preview however, or if the SDK are considered your top scenario, you might consider it as an acceptable side effect of a bug fix. Note that I'm not doing any recommendation about where it's the right solution or not, I just want to be sure you know the side effect of this one :)

[lebronJ]

Hi @lmazuel , thanks for the explanation. Per our team's internal discussion, we will treat this as a service bug fix and will change Face API's behavior to return lower case.

The reason behind this is the fact that our documentation and swagger are consistent (lower case), while response from service is different (upper case). Moreover, this API interface (Snapshot) is called in a quite low frequency since it was on board. So we think the potential side effect of fixing the service's response should be rather limited.

We have combined this fix in our ongoing release, if everything goes well, this issue will be solved by end of this week.