feat: apply field optional

[xeromank]

summary

• The optional attribute of the org.springframework.restdocs.payload.FieldDescriptor object allows expressing the required status.

story

First of all, thank you so much. Our team has been easily composing documentation for the OpenAPI3 spec using your code and RestDocs. However, there's one thing that's disappointing: we can't indicate the required status in this documentation. It seems like our team, as well as other users, are struggling with this aspect.

Of course, I can see that the solution is possible by looking at your sample code. However, finding it isn't straightforward.

The code is relatively straightforward as shown in the image above, but it took me quite a bit of time to solve this problem.

So, here's a suggestion:

While having various constraints is great, I believe that fundamentally knowing the required status in the documentation would be very helpful. I think this can be easily addressed by utilizing the optional attribute.

I kindly request you to review my pull request.

Finally, I'm not proficient in English, so I wrote this text using a translation tool. Please keep that in mind.

Thank you!!

[ozscheyge]

Hey,

Thank you for the contribution!

Linting failed:

* What went wrong:
Execution failed for task ':restdocs-api-spec-jsonschema:lintKotlinMain'.
> lintKotlinMain sources failed lint check

Please run

./gradlew formatKotlin

[xeromank]

@ozscheyge thank you. I solved the problem with your advice.