Skip to content

Include verb in gRPC JSON transcoding swagger path #47165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 13, 2023
Merged

Include verb in gRPC JSON transcoding swagger path #47165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .../src/Microsoft.AspNetCore.Grpc.Swagger/Internal/GrpcJsonTranscodingDescriptionProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,11 @@ private static string ResolvePath(HttpRoutePattern httpRoutePattern, Dictionary<
sb.Append(httpRoutePattern.Segments[i]);
}
}
if (httpRoutePattern.Verb != null)
Copy link
Member

@BrennanConroy BrennanConroy Mar 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit:

Suggested change
if (httpRoutePattern.Verb != null)
if (!string.IsNullOrEmpty(httpRoutePattern.Verb))

Copy link
Member Author

@JamesNK JamesNK Mar 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Purposefully using != null for trailing colon. (i.e. empty verb)

{
sb.Append(':');
sb.Append(httpRoutePattern.Verb);
}
return sb.ToString();
}

Expand Down
23 changes: 23 additions & 0 deletions ...sonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Parameters/ParametersTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,4 +160,27 @@ public void KnownTypes_AllQueryFields()
Assert.Equal("integer", operation.Parameters[2].Schema.Type);
Assert.Equal("int32", operation.Parameters[2].Schema.Format);
}

[Fact]
public void Verb()
{
// Arrange & Act
var swagger = OpenApiTestHelpers.GetOpenApiDocument<ParametersService>(_testOutputHelper);

// Assert
var path1 = swagger.Paths["/v1/parameters10/{parameterInt}:one"];
AssertParams(path1);
var path2 = swagger.Paths["/v1/parameters10/{parameterInt}:two"];
AssertParams(path2);

static void AssertParams(OpenApiPathItem path)
{
Assert.True(path.Operations.TryGetValue(OperationType.Get, out var operation));
Assert.Equal(2, operation.Parameters.Count);
Assert.Equal(ParameterLocation.Path, operation.Parameters[0].In);
Assert.Equal("parameterInt", operation.Parameters[0].Name);
Assert.Equal(ParameterLocation.Query, operation.Parameters[1].In);
Assert.Equal("parameterString", operation.Parameters[1].Name);
}
}
}
12 changes: 12 additions & 0 deletions src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Proto/parameters.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,18 @@ service Parameters {
get: "/v1/parameters9"
};
}

rpc DemoParametersTenOne (RequestOne) returns (ParamResponse) {
option (google.api.http) = {
get: "/v1/parameters10/{parameter_int}:one"
};
}

rpc DemoParametersTenTwo (RequestOne) returns (ParamResponse) {
option (google.api.http) = {
get: "/v1/parameters10/{parameter_int}:two"
};
}
}

message RequestOne {
Expand Down