joffrey-bion / livedoc

A not-so-annotation-based documentation generator for REST and websocket services
MIT License
4 stars 2 forks source link

Infer required properties from constraint annotations #85

Open joffrey-bion opened 6 years ago

joffrey-bion commented 6 years ago

The fact that some properties are "required" or "optional" could be inferred from constraint annotations like the following:

joffrey-bion commented 6 years ago

JetBrains's @NotNull/@Nullable are not available at runtime, so these ones cannot be taken into account.

jpeffer commented 6 years ago

Would be useful to support custom constraint annotations somehow as well.