Expose error details in AMQ APIs

[pakrym]

Both batched and non-batched queries can partially succeed. Expose the error type and define it in Azure.Core.Experemental because it follows Azure-wide error definition from https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#errorresponse--object

[KrzysztofCwalina]

Is this concept specific to Azure? i.e. should this be called ServiceError?

[pakrym]

It was called ServiceError in the first iteration. This exact shape is declared Azure REST guidenline as is Azure-specific.

[tg-msft]

I'd prefer not to call it ServiceError because that'll cause a lot of confusion for anyone trying to search: https://docs.microsoft.com/en-us/dotnet/api/?term=serviceerror

[KrzysztofCwalina]

that'll cause a lot of confusion for anyone trying to search

Good point. Thought, I would still like to avoid using "Azure" in general purpose APIs. Maybe ServiceResponseError? or just ResponseError?

[pakrym]

docs.microsoft.com/en-us/dotnet/api/?term=serviceerror

I don't think there are that many search results. For example, https://docs.microsoft.com/en-us/dotnet/api/?term=Response didn't stop us.

[tg-msft]

I kind of like either RequestError to tie it to RequestFailedException or ResponseError to tie it to Response*.

[pakrym]

RequestError sounds like it's a validation error (the request is wrong).

ErrorResponse?

[KrzysztofCwalina]

I think ErrorResponse implies that it's a subtype of Response.

[pakrym]

I like the ServiceError the most. It describes exactly what the type is about.

[christothes]

Would the value of HasFailed ever be false when the service operation succeeded? If so, why wouldn't we throw RequestFailedException rather than making someone interrogate this property? Is this just used for batches?

[pakrym]

It's for the batch response were some queries can succeed and some fail. For the single query scenario we always throw on failure.

[KrzysztofCwalina]

it's a bit strange that details of X is a collection of X.

[tg-msft]

And it's even stranger that InnerError is a different type... but https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses