Generating Multiple Path Bindings for Single gRPC Call

[jon-whit]

I have a field in a protobuf message called "parent". It looks like this:

message ListRolesRequest {
    // The resource name of the parent resource in one of the following formats:
    // `` (empty string) -- this refers to curated roles.
    // `organizations/{organization_id}`
    // `tenants/{tenant_id}`
    string parent = 1;
  ...
}

And a gRPC method that looks like this:

rpc ListRoles(ListRolesRequest) returns (ListRolesResponse) {
      option (google.api.http) = {
        get: "/auth/iam/roles"
        additional_bindings {
          get: "/auth/iam/{parent=organizations/*}/roles"
        }
        additional_bindings {
          get: "/auth/iam/{parent=tenants/*}/roles"
        }
      };
}

The parent can take the form organizations/<org_id> or tenants/<tenant_id> or it can be empty. I'd like the generated swagger definitions to match all three. For example:

GET /auth/iam/roles
GET /auth/iam/organizations/<org_id>/roles
GET /auth/iam/tenants/<tenant_id>/roles

The swagger generator currently only generates two paths:

GET /auth/iam/roles
GET /auth/iam/{parent}/roles

{parent} only matches a single path parameter, and since the parent can include a slash you can't get a match.

What's the correct way of doing this?

[jon-whit]

Was the use case outlined above addressed in #702, because I just pulled the latest and I don't see any differences in the generated swagger output.

Looping in @ch3rub1m

[ch3rub1m]

@jon-whit #702 is not about additional_bindings. It is for the resource name in path. I pulled the latest and it works well.

By the way, this maybe work in your case:

rpc ListRoles(ListRolesRequest) returns (ListRolesResponse) {
      option (google.api.http) = {
        get: "/auth/iam{parent=*}/roles"
      };
}

[jon-whit]

@ch3rub1m that doesn't even compile with the latest version of protoc. the { and} characters have to be preceded and followed by / characters.

[ch3rub1m]

@jon-whit How about this:

rpc ListRoles(ListRolesRequest) returns (ListRolesResponse) {
      option (google.api.http) = {
        get: "/auth/{parent=iam*}/roles"
      };
}

[jon-whit]

@ch3rub1m sorry man, I feel like we're clashing on this one... The problem with your example above is it doesn't adhere to my needs as stated above.

I need parent to match organizations/<org_id> or tenants/<tenant_id> or an empty string. Your example above would match iam/<something>.

[ch3rub1m]

@jon-whit I understood. I just propose a compromise between current features and what you want.

[jon-whit]

Is there anyone else that can speak to this? I guess I'm not fundamentally understanding why

/auth/iam/{parent=organizations/*}/roles

doesn't get transformed to something like

/auth/iam/organizations/{id}/roles

Could someone help me understand why this design choice was made?

[johanbrandhorst]

I'm afraid that information may be hard to come by, perhaps @achew22 will know?

[jon-whit]

@johanbrandhorst thanks for looping in here. I've been trying to figure out a solution to this issue for a while now, so any assistance is much appreciated :).

Thanks!

[jon-whit]

@achew22 Any ideas here?

[achew22]

@jon-whit unfortunately I don't have any specific ideas here. Step one is going to be create a failing test case. Do you think you could send in a PR that demonstrates this reliably?

[jon-whit]

@achew22 maybe I misunderstand.. The example above would be one such case..? What do you mean?