Clarifying Required and Optional Fields in Armeria Docs (Proto)

[jun-ohouse]

Issue

We’re currently collaborating with the frontend team using Armeria Docs, but we’ve encountered confusion due to how required fields are displayed.

1. Request Fields:
   • In the generated documentation, all request fields are marked as required: true, even when we use google.protobuf.StringValue or other optional types.
   • This makes it unclear which fields are actually required, leading to miscommunication.
   • As a result, we have to create a separate document to clarify field requirements, which is inconvenient.
2. Response Fields:
   • Conversely, all response fields are marked as optional, which also causes confusion.
   • We need a way to explicitly define whether a response field is truly optional or required.

Question
• Is there a way to accurately reflect required and optional fields in Armeria Docs?
• How can we prevent unnecessary confusion and avoid maintaining a separate document for clarification?

Would appreciate any guidance on how to properly configure this! 🚀

[minwoox]

If so, there should be a bug in GrpcDocServicePlugin while generating the FieldInfo. Are you interested in fixing it?

[jun-ohouse]

thanks for reply.
yes, can I try?

[minwoox]

It's all yours. 👍

[khj68]

I'll fix it and make PR with this account. Thanks 🙇

[ikhoon]

Fixed by #6153