You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We should add an io.swagger.v3.oas.annotations.media.Schema (or equivalent, such as @ArraySchema) annotation to each property of an entity (typically, those are the getter methods that are already annotated with @XmlElement).
This will allow for the auto-generated documentation to be enriched with a description of the property. Many of these descriptions are already available. They have been painstakingly added manually in the readme.md file. The can mostly be copied from there.
For example, a method like this:
/** * Gets whether this is a shared group * * @return whether it's a shared group */@XmlElement(name = "shared")
publicBooleangetShared(){ returnshared; }
Should be annotated as follows:
/** * Gets whether this is a shared group * * @return whether it's a shared group */@XmlElement(name = "shared")
@Schema(description = "Whether the group should automatically appear in the rosters of the users", example = "false")
publicBooleangetShared(){ returnshared; }
The text was updated successfully, but these errors were encountered:
We should add an
io.swagger.v3.oas.annotations.media.Schema
(or equivalent, such as@ArraySchema
) annotation to each property of an entity (typically, those are the getter methods that are already annotated with@XmlElement
).This will allow for the auto-generated documentation to be enriched with a description of the property. Many of these descriptions are already available. They have been painstakingly added manually in the
readme.md
file. The can mostly be copied from there.For example, a method like this:
Should be annotated as follows:
The text was updated successfully, but these errors were encountered: