fix: FieldDescriptor.description to nullable

ePages-de / restdocs-api-spec

Adds API specification support to Spring REST Docs

MIT License

391 stars 103 forks source link

fix: FieldDescriptor.description to nullable #263

Open seokjun7410 opened 8 months ago

seokjun7410 commented 8 months ago

Found and fixed an issue where openapi3 task would fail if no description was provided. https://github.com/ePages-de/restdocs-api-spec/issues/121

I think this is a problem for all tasks, not just the openapi3 task. So I changed the description field in the model to nullable.

If you're having trouble with this change, I'd appreciate direction.

seokjun7410 commented 6 months ago

@ozscheyge Please could you take a look at this PR

xeromank commented 2 months ago

i don't understand. do you really need nullable? If you don't want to define it, you can use .ignored(). nullable is a problem that can increase readability and complexity if not absolutely necessary.