V109

[EdLichtman]

Description

Cherry-Picked Commit of pull request 2002.
Includes: Better Documentation, and some tests for reliability and self-documentation

Purpose

This pull request is a:

• [ x ] Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

• [ X ] I have added tests that prove my fix is effective or that my feature works
• [ X ] I have added necessary documentation (if appropriate)

[tacosontitan]

This PR also considers the prior feedback from PR #2002 to utilize the code tag in the documentation.

_{This was supposed to be included with my review above.}

[EdLichtman]

How do I merge? it says you approved the changes, but it also says it requires approval?

[alexeyzimarev]

It's me who does the merge :)

[EdLichtman]

I tested the Koala test locally and it seems to be a transient error on the build server. Could it be due to request caps?

Would it be a good idea to change the PostAsync to use ExecuteAsync so we could publish the responseMessage instead?

Something like:

        const string filename = "Koala.jpg";

        var path = Path.Combine(_path, "Assets", filename);

        var request  = new RestRequest("upload").AddFile("file", path);
        var response = await _client.ExecutePostAsync<UploadResponse>(request);

        var expected = new UploadResponse(filename, new FileInfo(path).Length, true);

        response.Data.Should().BeEquivalentTo(expected, 
            $"Error making request. Data was: {JsonConvert.SerializeObject(response.Data)}.Response Status was:{response.StatusCode}. Reason: {response.ErrorMessage}");`

I have the code ready to go, but I wasn't sure if there was a specific reason this test was using PostAsync rather than ExecutePost.

[alexeyzimarev]

I will check, it was not failing before. Weird.