Browse Source

Improved documentation of enum fields

master
Jim Martens 10 months ago
parent
commit
cdba815c32
  1. 3
      oparl-server/src/main/java/de/twomartens/oparlservice/entity/Meeting.java
  2. 4
      oparl-server/src/main/java/de/twomartens/oparlservice/entity/Organization.java

3
oparl-server/src/main/java/de/twomartens/oparlservice/entity/Meeting.java

@ -49,7 +49,8 @@ public class Meeting {
@Schema(description = "name of the meeting")
private final String name;
@Schema(description = "current status of the meeting", allowableValues = "terminiert, eingeladen, durchgeführt", nullable = true)
@Schema(type = "string", description = "current status of the meeting",
allowableValues = "terminiert | eingeladen | durchgeführt", nullable = true)
private final MeetingState meetingState;
@Schema(description = "True if this meeting was cancelled")

4
oparl-server/src/main/java/de/twomartens/oparlservice/entity/Organization.java

@ -71,8 +71,8 @@ public class Organization {
@Schema(description = "URL to a parent organization", nullable = true)
private final String subOrganizationOf;
@Schema(description = "rough categorization of the organization", nullable = true,
allowableValues = "Gremium, Partei, Fraktion, Verwaltungsbereich, externes Gremium, Institution, Sonstiges")
@Schema(type = "string", description = "rough categorization of the organization", nullable = true,
allowableValues = "Gremium | Partei | Fraktion | Verwaltungsbereich | externes Gremium | Institution | Sonstiges")
private final OrganizationType organizationType;
@Schema(description = "type of organization", nullable = true)

Loading…
Cancel
Save