Skip to content
This repository has been archived by the owner on Aug 1, 2021. It is now read-only.

How do you specify optional attributes? #2

Open
doapp-ryanp opened this issue Apr 19, 2018 · 1 comment
Open

How do you specify optional attributes? #2

doapp-ryanp opened this issue Apr 19, 2018 · 1 comment

Comments

@doapp-ryanp
Copy link

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
Copy link
Owner

elliots commented May 7, 2018

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants