Google Empty type not supported property

[cosmotek]

With ConnectRPC requests, RPC methods that include the Empty type still require the request body to include {}. This protoc plugin generates OpenAPIv3 spec that doesn't include requestBody. This is breaking Swagger/Stoplight Element UI for me.

Also, unless I have something configured incorrectly, Connect folds XValue types such as StringValue into a single string in requests. For example, instead of {"value": "hello"} connect expects "hello".

[sudorandom]

Good callout on empty request bodies. I don't have a test that covers this today.

Do you have any documentation on Connect's behavior with {"value": "hello"} ? What you describe sounds like the behavior specifically for the google.protobuf.Value well-known type, which I do believe this library captures correctly.

[cosmotek]

No problem.

I can't find docs on that later case, but I agree it seems like expected behavior. Connect doesn't document this anywhere, but I know for a fact this is how it works. These two methods in my service only work with the primitive values in JSON, not the wrapping types.

  rpc HealthCheck(google.protobuf.StringValue) returns (google.protobuf.StringValue);
  rpc ServiceConfig(google.protobuf.Empty) returns (commons.ServiceConfiguration);

[cosmotek]

Please let me know when you'll have a patch in for the empty type. I'd love to upgrade to fix my interactive web docs.

Thanks!

P.S: Happy to help here if needed.

[sudorandom]

@cosmotek I have a branch for a major refactor that I'm finishing up soon where I switch the jsonschema/openapi library that I use. I did some quick additions that may fix this for you. I need to spend a little bit more time testing it but you can see if that works for you:

go install github.com/sudorandom/protoc-gen-connect-openapi@major-refactor

[cosmotek]

@sudorandom Not seeing any impact from generating with this version. Maybe I missed something but it looks like we're still not getting the empty type at all.

[sudorandom]

@cosmotek can you make sure it's updated? I accidentally didn't push the change until after I sent that message so there's a chance you're on an old version.

I've been testing with redoc and this is what it looks like:

service Test {
  rpc Empty(google.protobuf.Empty) returns (google.protobuf.Empty);
}

paths:
  /samples.Test/Empty:
    post:
      tags:
        - samples.Test
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/google.protobuf.Empty'
        required: true
components:
  schemas:
    google.protobuf.Empty:
      type: object
      description: |-
        A generic empty message that you can re-use to avoid defining duplicated
         empty messages in your APIs. A typical example is to use it as the request
         or the response type of an API method. For instance:

             service Foo {
               rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
             }

[cosmotek]

Ill test now

[cosmotek]

Nice. Looks to be fixed.

Please let me know when you release these changes officially.

[sudorandom]

@cosmotek I've made a new release (v0.8.1) that includes these changes. Try it out and let me know if you hit any other issues!

Cheers!