From cdba815c328d23f5e56049985acbbc4770b4ee82 Mon Sep 17 00:00:00 2001 From: Jim Martens Date: Fri, 10 Jul 2020 23:02:03 +0200 Subject: [PATCH] Improved documentation of enum fields --- .../main/java/de/twomartens/oparlservice/entity/Meeting.java | 3 ++- .../java/de/twomartens/oparlservice/entity/Organization.java | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/oparl-server/src/main/java/de/twomartens/oparlservice/entity/Meeting.java b/oparl-server/src/main/java/de/twomartens/oparlservice/entity/Meeting.java index 2800584..86d37cb 100644 --- a/oparl-server/src/main/java/de/twomartens/oparlservice/entity/Meeting.java +++ b/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") diff --git a/oparl-server/src/main/java/de/twomartens/oparlservice/entity/Organization.java b/oparl-server/src/main/java/de/twomartens/oparlservice/entity/Organization.java index 445441a..e805103 100644 --- a/oparl-server/src/main/java/de/twomartens/oparlservice/entity/Organization.java +++ b/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)