How to use ToSchema with generated protobuf structs?

[boan-anbo]

Hi there!

I use generated structs from .proto files using prost-build which produces something like this:

• After I add both DistantApiSearchResponse and Passage to Api components, the OpenApi spec has the correct schema for both objects:

• However, the $ref on DistantApiSearchResponse.properties.passages.items points to super.passage.Passage rather than Passage, because the way Prost generated the struct (which I don't have much control of). This causes Swagger to fail.

So I was wondering if there is any way to specify the $ref?

Thanks so much!

[boan-anbo]

Solved by making changes to prost-build process, adding type_attribute.

• Add the following to prost_build::Config::()

.field_attribute("DistantApiSearchResponse.passages", "#[schema(value_type=Vec<Passage>)]")

• This will let Utoipa's wonderful ToSchema macros take care of changing the $ref.

• Now the new schema looks like: