search

elliots / protoc-gen-twirp_swagger

Swagger generator for twirp
Other
62 stars 15 forks source link

How do you specify optional attributes? #2

Open doapp-ryanp opened 6 years ago

doapp-ryanp commented 6 years ago

Not sure this is a limitation of Twirp or .proto(3), but how do you convey to consumers that an attribute is optional?

For example what if I wanted to make the inches attribute optional on twitch.twirp.example.Haberdasher/MakeHat? I know I could manually modify the generated swagger.json file, however that diminishes the value of auto-generation.

elliots commented 6 years ago

Required/optional doesn't exist in proto3. We could do it with some extended proto annotations though.

I started some work generating json-schema from the same proto files, and using them in the generated swagger file (see use-refs-to-jsonschema branch) but it isn't in a working state yet.