Skip to content

Commit eb69bc9

Browse files
bkoelmanbkoelman
committed
Naming consistency: use requestBody and response for OpenAPI calls
1 parent 5561496 commit eb69bc9

File tree

16 files changed

+388
-388
lines changed

16 files changed

+388
-388
lines changed

‎src/Examples/OpenApiKiotaClientExample/Worker.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
5252
_hostApplicationLifetime.StopApplication();
5353
}
5454

55-
private async Task<(PersonCollectionResponseDocument? response, string? eTag)> GetPeopleAsync(ExampleApiClient apiClient, string? ifNoneMatch,
55+
private static async Task<(PersonCollectionResponseDocument? response, string? eTag)> GetPeopleAsync(ExampleApiClient apiClient, string? ifNoneMatch,
5656
CancellationToken cancellationToken)
5757
{
5858
try
@@ -62,7 +62,7 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
6262
InspectResponseHeaders = true
6363
};
6464

65-
PersonCollectionResponseDocument? responseDocument = await apiClient.Api.People.GetAsync(configuration =>
65+
PersonCollectionResponseDocument? response = await apiClient.Api.People.GetAsync(configuration =>
6666
{
6767
if (!string.IsNullOrEmpty(ifNoneMatch))
6868
{
@@ -74,7 +74,7 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
7474

7575
string eTag = headerInspector.ResponseHeaders["ETag"].Single();
7676

77-
return (responseDocument, eTag);
77+
return (response, eTag);
7878
}
7979
// Workaround for https://github.com/microsoft/kiota/issues/4190.
8080
catch (ApiException exception) when (exception.ResponseStatusCode == (int)HttpStatusCode.NotModified)

‎test/OpenApiKiotaEndToEndTests/ClientIdGenerationModes/ClientIdGenerationModesTests.cs‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,10 @@ public async Task Can_create_resource_with_ID_when_supplying_ID_is_required()
9191
};
9292

9393
// Act
94-
PlayerPrimaryResponseDocument? document = await apiClient.Players.PostAsync(requestBody);
94+
PlayerPrimaryResponseDocument? response = await apiClient.Players.PostAsync(requestBody);
9595

9696
// Assert
97-
document.Should().BeNull();
97+
response.Should().BeNull();
9898

9999
await _testContext.RunOnDatabaseAsync(async dbContext =>
100100
{
@@ -127,17 +127,17 @@ public async Task Can_create_resource_without_ID_when_supplying_ID_is_allowed()
127127
};
128128

129129
// Act
130-
GamePrimaryResponseDocument? document = await apiClient.Games.PostAsync(requestBody);
130+
GamePrimaryResponseDocument? response = await apiClient.Games.PostAsync(requestBody);
131131

132132
// Assert
133-
document.Should().NotBeNull();
134-
document.Data.Should().NotBeNull();
135-
document.Data.Id.Should().NotBeNull();
136-
document.Data.Id.Value.Should().NotBe(Guid.Empty);
133+
response.Should().NotBeNull();
134+
response.Data.Should().NotBeNull();
135+
response.Data.Id.Should().NotBeNull();
136+
response.Data.Id.Value.Should().NotBe(Guid.Empty);
137137

138138
await _testContext.RunOnDatabaseAsync(async dbContext =>
139139
{
140-
Game gameInDatabase = await dbContext.Games.FirstWithIdAsync(document.Data.Id.Value);
140+
Game gameInDatabase = await dbContext.Games.FirstWithIdAsync(response.Data.Id.Value);
141141

142142
gameInDatabase.Title.Should().Be(newGame.Title);
143143
gameInDatabase.PurchasePrice.Should().Be(newGame.PurchasePrice);
@@ -169,10 +169,10 @@ public async Task Can_create_resource_with_ID_when_supplying_ID_is_allowed()
169169
};
170170

171171
// Act
172-
GamePrimaryResponseDocument? document = await apiClient.Games.PostAsync(requestBody);
172+
GamePrimaryResponseDocument? response = await apiClient.Games.PostAsync(requestBody);
173173

174174
// Assert
175-
document.Should().BeNull();
175+
response.Should().BeNull();
176176

177177
await _testContext.RunOnDatabaseAsync(async dbContext =>
178178
{
@@ -249,14 +249,14 @@ public async Task Can_create_resource_without_ID_when_supplying_ID_is_forbidden(
249249
};
250250

251251
// Act
252-
PlayerGroupPrimaryResponseDocument? document = await apiClient.PlayerGroups.PostAsync(requestBody);
252+
PlayerGroupPrimaryResponseDocument? response = await apiClient.PlayerGroups.PostAsync(requestBody);
253253

254254
// Assert
255-
document.Should().NotBeNull();
256-
document.Data.Should().NotBeNull();
257-
document.Data.Id.Should().NotBeNullOrEmpty();
255+
response.Should().NotBeNull();
256+
response.Data.Should().NotBeNull();
257+
response.Data.Id.Should().NotBeNullOrEmpty();
258258

259-
long newPlayerGroupId = long.Parse(document.Data.Id);
259+
long newPlayerGroupId = long.Parse(response.Data.Id);
260260

261261
await _testContext.RunOnDatabaseAsync(async dbContext =>
262262
{

‎test/OpenApiKiotaEndToEndTests/ModelStateValidation/ModelStateValidationTests.cs‎

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,10 @@ public async Task Cannot_exceed_length_constraint(string firstName)
5959
Func<Task> action = () => apiClient.SocialMediaAccounts.PostAsync(requestBody);
6060

6161
// Assert
62-
ErrorResponseDocument document = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
63-
document.Errors.Should().HaveCount(1);
62+
ErrorResponseDocument response = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
63+
response.Errors.Should().HaveCount(1);
6464

65-
ErrorObject errorObject = document.Errors.First();
65+
ErrorObject errorObject = response.Errors.First();
6666
errorObject.Title.Should().Be("Input validation failed.");
6767
errorObject.Detail.Should().Be("The field FirstName must be a string or collection type with a minimum length of '2' and maximum length of '20'.");
6868
errorObject.Source.Should().NotBeNull();
@@ -97,10 +97,10 @@ public async Task Cannot_exceed_string_length_constraint(string userName)
9797
Func<Task> action = () => apiClient.SocialMediaAccounts.PostAsync(requestBody);
9898

9999
// Assert
100-
ErrorResponseDocument document = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
101-
document.Errors.Should().HaveCount(1);
100+
ErrorResponseDocument response = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
101+
response.Errors.Should().HaveCount(1);
102102

103-
ErrorObject errorObject = document.Errors.First();
103+
ErrorObject errorObject = response.Errors.First();
104104
errorObject.Title.Should().Be("Input validation failed.");
105105
errorObject.Detail.Should().Be("The field UserName must be a string with a minimum length of 3 and a maximum length of 18.");
106106
errorObject.Source.Should().NotBeNull();
@@ -133,10 +133,10 @@ public async Task Cannot_violate_regular_expression_constraint()
133133
Func<Task> action = () => apiClient.SocialMediaAccounts.PostAsync(requestBody);
134134

135135
// Assert
136-
ErrorResponseDocument document = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
137-
document.Errors.Should().HaveCount(1);
136+
ErrorResponseDocument response = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
137+
response.Errors.Should().HaveCount(1);
138138

139-
ErrorObject errorObject = document.Errors.First();
139+
ErrorObject errorObject = response.Errors.First();
140140
errorObject.Title.Should().Be("Input validation failed.");
141141
errorObject.Detail.Should().Be("Only letters are allowed.");
142142
errorObject.Source.Should().NotBeNull();
@@ -169,10 +169,10 @@ public async Task Cannot_use_invalid_credit_card_number()
169169
Func<Task> action = () => apiClient.SocialMediaAccounts.PostAsync(requestBody);
170170

171171
// Assert
172-
ErrorResponseDocument document = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
173-
document.Errors.Should().HaveCount(1);
172+
ErrorResponseDocument response = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
173+
response.Errors.Should().HaveCount(1);
174174

175-
ErrorObject errorObject = document.Errors.First();
175+
ErrorObject errorObject = response.Errors.First();
176176
errorObject.Title.Should().Be("Input validation failed.");
177177
errorObject.Detail.Should().Be("The CreditCard field is not a valid credit card number.");
178178
errorObject.Source.Should().NotBeNull();
@@ -205,10 +205,10 @@ public async Task Cannot_use_invalid_email_address()
205205
Func<Task> action = () => apiClient.SocialMediaAccounts.PostAsync(requestBody);
206206

207207
// Assert
208-
ErrorResponseDocument document = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
209-
document.Errors.Should().HaveCount(1);
208+
ErrorResponseDocument response = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
209+
response.Errors.Should().HaveCount(1);
210210

211-
ErrorObject errorObject = document.Errors.First();
211+
ErrorObject errorObject = response.Errors.First();
212212
errorObject.Title.Should().Be("Input validation failed.");
213213
errorObject.Detail.Should().Be("The Email field is not a valid e-mail address.");
214214
errorObject.Source.Should().NotBeNull();
@@ -242,12 +242,12 @@ public async Task Cannot_exceed_min_length_constraint()
242242
Func<Task> action = () => apiClient.SocialMediaAccounts.PostAsync(requestBody);
243243

244244
// Assert
245-
ErrorResponseDocument document = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
246-
document.Errors.Should().HaveCount(1);
245+
ErrorResponseDocument response = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
246+
response.Errors.Should().HaveCount(1);
247247

248248
const int minCharsInBase64 = SocialMediaAccount.MinPasswordCharsInBase64;
249249

250-
ErrorObject errorObject = document.Errors.First();
250+
ErrorObject errorObject = response.Errors.First();
251251
errorObject.Title.Should().Be("Input validation failed.");
252252
errorObject.Detail.Should().Be($"The field Password must be a string or array type with a minimum length of '{minCharsInBase64}'.");
253253
errorObject.Source.Should().NotBeNull();
@@ -280,12 +280,12 @@ public async Task Cannot_exceed_max_length_constraint()
280280
Func<Task> action = () => apiClient.SocialMediaAccounts.PostAsync(requestBody);
281281

282282
// Assert
283-
ErrorResponseDocument document = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
284-
document.Errors.Should().HaveCount(1);
283+
ErrorResponseDocument response = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
284+
response.Errors.Should().HaveCount(1);
285285

286286
const int maxCharsInBase64 = SocialMediaAccount.MaxPasswordCharsInBase64;
287287

288-
ErrorObject errorObject = document.Errors.First();
288+
ErrorObject errorObject = response.Errors.First();
289289
errorObject.Title.Should().Be("Input validation failed.");
290290
errorObject.Detail.Should().Be($"The field Password must be a string or array type with a maximum length of '{maxCharsInBase64}'.");
291291
errorObject.Source.Should().NotBeNull();
@@ -322,10 +322,10 @@ public async Task Cannot_use_double_outside_of_valid_range(double age)
322322
Func<Task> action = () => apiClient.SocialMediaAccounts.PostAsync(requestBody);
323323

324324
// Assert
325-
ErrorResponseDocument document = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
326-
document.Errors.Should().HaveCount(1);
325+
ErrorResponseDocument response = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
326+
response.Errors.Should().HaveCount(1);
327327

328-
ErrorObject errorObject = document.Errors.First();
328+
ErrorObject errorObject = response.Errors.First();
329329
errorObject.Title.Should().Be("Input validation failed.");
330330
errorObject.Detail.Should().Be($"The field Age must be between {0.1} exclusive and {122.9} exclusive.");
331331
errorObject.Source.Should().NotBeNull();
@@ -358,10 +358,10 @@ public async Task Cannot_use_relative_url()
358358
Func<Task> action = () => apiClient.SocialMediaAccounts.PostAsync(requestBody);
359359

360360
// Assert
361-
ErrorResponseDocument document = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
362-
document.Errors.Should().HaveCount(1);
361+
ErrorResponseDocument response = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
362+
response.Errors.Should().HaveCount(1);
363363

364-
ErrorObject errorObject = document.Errors.First();
364+
ErrorObject errorObject = response.Errors.First();
365365
errorObject.Title.Should().Be("Input validation failed.");
366366
errorObject.Detail.Should().Be("The BackgroundPicture field is not a valid fully-qualified http, https, or ftp URL.");
367367
errorObject.Source.Should().NotBeNull();
@@ -396,10 +396,10 @@ public async Task Cannot_exceed_collection_length_constraint(int length)
396396
Func<Task> action = () => apiClient.SocialMediaAccounts.PostAsync(requestBody);
397397

398398
// Assert
399-
ErrorResponseDocument document = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
400-
document.Errors.Should().HaveCount(1);
399+
ErrorResponseDocument response = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
400+
response.Errors.Should().HaveCount(1);
401401

402-
ErrorObject errorObject = document.Errors.First();
402+
ErrorObject errorObject = response.Errors.First();
403403
errorObject.Title.Should().Be("Input validation failed.");
404404
errorObject.Detail.Should().Be("The field Tags must be a string or collection type with a minimum length of '1' and maximum length of '10'.");
405405
errorObject.Source.Should().NotBeNull();
@@ -432,10 +432,10 @@ public async Task Cannot_use_non_allowed_value()
432432
Func<Task> action = () => apiClient.SocialMediaAccounts.PostAsync(requestBody);
433433

434434
// Assert
435-
ErrorResponseDocument document = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
436-
document.Errors.Should().HaveCount(1);
435+
ErrorResponseDocument response = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
436+
response.Errors.Should().HaveCount(1);
437437

438-
ErrorObject errorObject = document.Errors.First();
438+
ErrorObject errorObject = response.Errors.First();
439439
errorObject.Title.Should().Be("Input validation failed.");
440440
errorObject.Detail.Should().Be("The CountryCode field does not equal any of the values specified in AllowedValuesAttribute.");
441441
errorObject.Source.Should().NotBeNull();
@@ -468,10 +468,10 @@ public async Task Cannot_use_denied_value()
468468
Func<Task> action = () => apiClient.SocialMediaAccounts.PostAsync(requestBody);
469469

470470
// Assert
471-
ErrorResponseDocument document = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
472-
document.Errors.Should().HaveCount(1);
471+
ErrorResponseDocument response = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
472+
response.Errors.Should().HaveCount(1);
473473

474-
ErrorObject errorObject = document.Errors.First();
474+
ErrorObject errorObject = response.Errors.First();
475475
errorObject.Title.Should().Be("Input validation failed.");
476476
errorObject.Detail.Should().Be("The Planet field equals one of the values specified in DeniedValuesAttribute.");
477477
errorObject.Source.Should().NotBeNull();
@@ -504,10 +504,10 @@ public async Task Cannot_use_TimeSpan_outside_of_valid_range()
504504
Func<Task> action = () => apiClient.SocialMediaAccounts.PostAsync(requestBody);
505505

506506
// Assert
507-
ErrorResponseDocument document = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
508-
document.Errors.Should().HaveCount(1);
507+
ErrorResponseDocument response = (await action.Should().ThrowExactlyAsync<ErrorResponseDocument>()).Which;
508+
response.Errors.Should().HaveCount(1);
509509

510-
ErrorObject errorObject = document.Errors.First();
510+
ErrorObject errorObject = response.Errors.First();
511511
errorObject.Title.Should().Be("Input validation failed.");
512512
errorObject.Detail.Should().Be("The field NextRevalidation must be between 01:00:00 and 05:00:00.");
513513
errorObject.Source.Should().NotBeNull();

0 commit comments

Comments
 (0)