2martens
/
oparl-service
generated from 2martens/template-service
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Removed nullable value as null values are not sent via JSON

This commit is contained in:
Jim Martens 2020-07-11 22:17:34 +02:00
parent 7e62fb8c9c
commit b08c8cc9c3
14 changed files with 175 additions and 175 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
oparl-server/src/main/java/de/twomartens/oparlservice/entity/AgendaItem.java
View File

@ -35,54 +35,54 @@ public class AgendaItem {
@Schema(required = true, description = "Date and time of the last update of the object") @Schema(required = true, description = "Date and time of the last update of the object")
private final ZonedDateTime modified; private final ZonedDateTime modified;
@Schema(description = "URL to the license", nullable = true) @Schema(description = "URL to the license")
private String license; private String license;
@Schema(description = "Categorization of the object", nullable = true) @Schema(description = "Categorization of the object")
private String keyword; private String keyword;
@Schema(description = "URL of a website that presents the object in the browser", nullable = true) @Schema(description = "URL of a website that presents the object in the browser")
private String web; private String web;
@Schema(description = "True, if the object was deleted") @Schema(description = "True, if the object was deleted")
private final boolean deleted; private final boolean deleted;
@Schema(description = "URL to the meeting this agenda item is part of", nullable = true) @Schema(description = "URL to the meeting this agenda item is part of")
private final String meeting; private final String meeting;
@Schema(description = "number of the agenda item", nullable = true, example = "10.1, A, ...") @Schema(description = "number of the agenda item", example = "10.1, A, ...")
private final String number; private final String number;
@Schema(description = "position of the agenda item in the meeting based on 0", required = true) @Schema(description = "position of the agenda item in the meeting based on 0", required = true)
private final int order; private final int order;
@Schema(description = "the topic of the agenda item", nullable = true) @Schema(description = "the topic of the agenda item")
private final String name; private final String name;
@JsonProperty("public") @JsonProperty("public")
@Schema(description = "True if the agenda item is public") @Schema(description = "True if the agenda item is public")
private final boolean isPublic; private final boolean isPublic;
@Schema(description = "URL to the consultation related to this agenda item", nullable = true) @Schema(description = "URL to the consultation related to this agenda item")
private final String consultation; private final String consultation;
@Schema(description = "categorical information about result of consultation of this agenda item", nullable = true) @Schema(description = "categorical information about result of consultation of this agenda item")
private final String result; private final String result;
@Schema(description = "resolution text of a decision in this agenda item", nullable = true) @Schema(description = "resolution text of a decision in this agenda item")
private final String resolutionText; private final String resolutionText;
@Schema(description = "resolution file of a decision in this agenda item", nullable = true) @Schema(description = "resolution file of a decision in this agenda item")
private final File resolutionFile; private final File resolutionFile;
@Schema(description = "additional appendices to this agenda item", nullable = true) @Schema(description = "additional appendices to this agenda item")
private final List<File> auxiliaryFile; private final List<File> auxiliaryFile;
@JsonFormat(shape = JsonFormat.Shape.STRING) @JsonFormat(shape = JsonFormat.Shape.STRING)
@Schema(description = "date and time of the begin of the agenda item", nullable = true) @Schema(description = "date and time of the begin of the agenda item")
private final ZonedDateTime start; private final ZonedDateTime start;
@JsonFormat(shape = JsonFormat.Shape.STRING) @JsonFormat(shape = JsonFormat.Shape.STRING)
@Schema(description = "date and time of the end of the agenda item", nullable = true) @Schema(description = "date and time of the end of the agenda item")
private final ZonedDateTime end; private final ZonedDateTime end;
} }

30
oparl-server/src/main/java/de/twomartens/oparlservice/entity/Body.java
View File

@ -35,52 +35,52 @@ public class Body {
@Schema(required = true, description = "Date and time of the last update of the object") @Schema(required = true, description = "Date and time of the last update of the object")
private final ZonedDateTime modified; private final ZonedDateTime modified;
@Schema(description = "URL to the license", nullable = true) @Schema(description = "URL to the license")
private String license; private String license;
@Schema(description = "Categorization of the object", nullable = true) @Schema(description = "Categorization of the object")
private String keyword; private String keyword;
@Schema(description = "URL of a website that presents the object in the browser", nullable = true) @Schema(description = "URL of a website that presents the object in the browser")
private String web; private String web;
@Schema(description = "True, if the object was deleted") @Schema(description = "True, if the object was deleted")
private final boolean deleted; private final boolean deleted;
@Schema(description = "URL to the system this body belongs to", nullable = true) @Schema(description = "URL to the system this body belongs to")
private final String system; private final String system;
@NonNull @NonNull
@Schema(required = true, description = "official long name of the body") @Schema(required = true, description = "official long name of the body")
private final String name; private final String name;
@Schema(description = "short name of the body", nullable = true) @Schema(description = "short name of the body")
private final String shortName; private final String shortName;
@Schema(description = "URL of the website of the body", nullable = true) @Schema(description = "URL of the website of the body")
private final String website; private final String website;
@JsonFormat(shape = JsonFormat.Shape.STRING) @JsonFormat(shape = JsonFormat.Shape.STRING)
@Schema(description = "Date and time from which the specified license is valid", nullable = true) @Schema(description = "Date and time from which the specified license is valid")
private final ZonedDateTime licenseValidSince; private final ZonedDateTime licenseValidSince;
@JsonFormat(shape = JsonFormat.Shape.STRING) @JsonFormat(shape = JsonFormat.Shape.STRING)
@Schema(description = "Date and time from which OParl API has been offered", nullable = true) @Schema(description = "Date and time from which OParl API has been offered")
private final ZonedDateTime oparlSince; private final ZonedDateTime oparlSince;
@Schema(description = "The eight character long official body identifier", nullable = true) @Schema(description = "The eight character long official body identifier")
private final String ags; private final String ags;
@Schema(description = "The 12 character long regional identifier", nullable = true) @Schema(description = "The 12 character long regional identifier")
private final String rgs; private final String rgs;
@Schema(description = "list of additional URLs that represent this body", nullable = true) @Schema(description = "list of additional URLs that represent this body")
private final List<String> equivalent; private final List<String> equivalent;
@Schema(description = "E-Mail-Address for requests related to the body and the parliamentary information system", nullable = true) @Schema(description = "E-Mail-Address for requests related to the body and the parliamentary information system")
private final String contactEmail; private final String contactEmail;
@Schema(description = "Name of the contact person or office reachable by contactEmail", nullable = true) @Schema(description = "Name of the contact person or office reachable by contactEmail")
private final String contactName; private final String contactName;
@NonNull @NonNull
@ -127,12 +127,12 @@ public class Body {
@Schema(required = true, description = "URL to list of all memberships in this body") @Schema(required = true, description = "URL to list of all memberships in this body")
private final String membership; private final String membership;
@Schema(description = "physical location of the body", nullable = true) @Schema(description = "physical location of the body")
private final Location location; private final Location location;
@Schema(description = "classification of the body") @Schema(description = "classification of the body")
private final String classification; private final String classification;
@Schema(description = "URL to the main organization of this body", nullable = true) @Schema(description = "URL to the main organization of this body")
private final String mainOrganization; private final String mainOrganization;
} }

16
oparl-server/src/main/java/de/twomartens/oparlservice/entity/Consultation.java
View File

@ -34,33 +34,33 @@ public class Consultation {
@Schema(required = true, description = "Date and time of the last update of the object") @Schema(required = true, description = "Date and time of the last update of the object")
private final ZonedDateTime modified; private final ZonedDateTime modified;
@Schema(description = "URL to the license", nullable = true) @Schema(description = "URL to the license")
private String license; private String license;
@Schema(description = "Categorization of the object", nullable = true) @Schema(description = "Categorization of the object")
private String keyword; private String keyword;
@Schema(description = "URL of a website that presents the object in the browser", nullable = true) @Schema(description = "URL of a website that presents the object in the browser")
private String web; private String web;
@Schema(description = "True, if the object was deleted") @Schema(description = "True, if the object was deleted")
private final boolean deleted; private final boolean deleted;
@Schema(description = "URL to the paper related to this consultation", nullable = true) @Schema(description = "URL to the paper related to this consultation")
private final String paper; private final String paper;
@Schema(description = "URL to the agenda item related to this consultation", nullable = true) @Schema(description = "URL to the agenda item related to this consultation")
private final String agendaItem; private final String agendaItem;
@Schema(description = "URL to the meeting related to this consultation", nullable = true) @Schema(description = "URL to the meeting related to this consultation")
private final String meeting; private final String meeting;
@Schema(description = "List of URLs to organizations that participate in this consultation", nullable = true) @Schema(description = "List of URLs to organizations that participate in this consultation")
private final List<String> organization; private final List<String> organization;
@Schema(description = "True if a decision will be or has been reached in this consultation") @Schema(description = "True if a decision will be or has been reached in this consultation")
private final boolean authoritative; private final boolean authoritative;
@Schema(description = "role or function of this consultation", example = "Anhörung, Entscheidung, usw", nullable = true) @Schema(description = "role or function of this consultation", example = "Anhörung, Entscheidung, usw")
private final String role; private final String role;
} }

38
oparl-server/src/main/java/de/twomartens/oparlservice/entity/File.java
View File

@ -35,71 +35,71 @@ public class File {
@Schema(required = true, description = "Date and time of the last update of the object") @Schema(required = true, description = "Date and time of the last update of the object")
private final ZonedDateTime modified; private final ZonedDateTime modified;
@Schema(description = "URL to the license", nullable = true) @Schema(description = "URL to the license")
private String license; private String license;
@Schema(description = "Categorization of the object", nullable = true) @Schema(description = "Categorization of the object")
private String keyword; private String keyword;
@Schema(description = "URL of a website that presents the object in the browser", nullable = true) @Schema(description = "URL of a website that presents the object in the browser")
private String web; private String web;
@Schema(description = "True, if the object was deleted") @Schema(description = "True, if the object was deleted")
private final boolean deleted; private final boolean deleted;
@Schema(description = "name of the file without file ending", nullable = true) @Schema(description = "name of the file without file ending")
private final String name; private final String name;
@Schema(description = "file name of the file", nullable = true) @Schema(description = "file name of the file")
private final String fileName; private final String fileName;
@Schema(description = "mime type of this file", nullable = true) @Schema(description = "mime type of this file")
private final String mimeType; private final String mimeType;
@JsonFormat(shape = JsonFormat.Shape.STRING) @JsonFormat(shape = JsonFormat.Shape.STRING)
@Schema(description = "date which is used, for example, as a reference for deadlines", nullable = true) @Schema(description = "date which is used, for example, as a reference for deadlines")
private final LocalDate date; private final LocalDate date;
@Schema(description = "size of the file in bytes") @Schema(description = "size of the file in bytes")
private final int size; private final int size;
@Schema(description = "SHA1 checksum of the file content in hexadecimal form", deprecated = true, nullable = true) @Schema(description = "SHA1 checksum of the file content in hexadecimal form", deprecated = true)
private final String sha1Checksum; private final String sha1Checksum;
@Schema(description = "SHA512 checksum of the file content in hexadecimal form", nullable = true) @Schema(description = "SHA512 checksum of the file content in hexadecimal form")
private final String sha512Checksum; private final String sha512Checksum;
@Schema(description = "pure text representation of the file content if possible", nullable = true) @Schema(description = "pure text representation of the file content if possible")
private final String text; private final String text;
@NonNull @NonNull
@Schema(description = "URL to access the file", required = true) @Schema(description = "URL to access the file", required = true)
private final String accessUrl; private final String accessUrl;
@Schema(description = "URL to download the file", nullable = true) @Schema(description = "URL to download the file")
private final String downloadUrl; private final String downloadUrl;
@Schema(description = "URL to an additional access possibility", nullable = true) @Schema(description = "URL to an additional access possibility")
private final String externalServiceUrl; private final String externalServiceUrl;
@Schema(description = "URL to the master file from which this file was derived", nullable = true) @Schema(description = "URL to the master file from which this file was derived")
private final String masterFile; private final String masterFile;
@Schema(description = "List of URLs to files that were derived from this file", nullable = true) @Schema(description = "List of URLs to files that were derived from this file")
private final List<String> derivativeFile; private final List<String> derivativeFile;
@Schema(description = "URL to the license for this file", nullable = true) @Schema(description = "URL to the license for this file")
private final String fileLicense; private final String fileLicense;
@Schema(description = "List of URLs to meetings this file is referenced in", nullable = true) @Schema(description = "List of URLs to meetings this file is referenced in")
private final List<String> meeting; private final List<String> meeting;
@Schema(description = "List of URLs to agenda items this file is referenced in", nullable = true) @Schema(description = "List of URLs to agenda items this file is referenced in")
private final List<String> agendaItem; private final List<String> agendaItem;
@Schema(description = "URL to the person which uses this file as image", nullable = true) @Schema(description = "URL to the person which uses this file as image")
private final String person; private final String person;
@Schema(description = "List of URLs to papers this file is referenced in", nullable = true) @Schema(description = "List of URLs to papers this file is referenced in")
private final List<String> paper; private final List<String> paper;
} }

14
oparl-server/src/main/java/de/twomartens/oparlservice/entity/LegislativeTerm.java
View File

@ -34,29 +34,29 @@ public class LegislativeTerm {
@Schema(required = true, description = "Date and time of the last update of the object") @Schema(required = true, description = "Date and time of the last update of the object")
private final ZonedDateTime modified; private final ZonedDateTime modified;
@Schema(description = "URL to the license", nullable = true) @Schema(description = "URL to the license")
private String license; private String license;
@Schema(description = "Categorization of the object", nullable = true) @Schema(description = "Categorization of the object")
private String keyword; private String keyword;
@Schema(description = "URL of a website that presents the object in the browser", nullable = true) @Schema(description = "URL of a website that presents the object in the browser")
private String web; private String web;
@Schema(description = "True, if the object was deleted") @Schema(description = "True, if the object was deleted")
private final boolean deleted; private final boolean deleted;
@Schema(description = "URL to body this legislative term belongs to", nullable = true) @Schema(description = "URL to body this legislative term belongs to")
private final String body; private final String body;
@Schema(description = "User friendly name of legislative term", nullable = true) @Schema(description = "User friendly name of legislative term")
private final String name; private final String name;
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd") @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")
@Schema(description = "First day of legislative term", nullable = true) @Schema(description = "First day of legislative term")
private final LocalDate startDate; private final LocalDate startDate;
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd") @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")
@Schema(description = "Last day of legislative term", nullable = true) @Schema(description = "Last day of legislative term")
private final LocalDate endDate; private final LocalDate endDate;
} }

10
oparl-server/src/main/java/de/twomartens/oparlservice/entity/Links.java
View File

@ -12,21 +12,21 @@ import lombok.*;
@NoArgsConstructor(force = true, access = AccessLevel.PRIVATE) @NoArgsConstructor(force = true, access = AccessLevel.PRIVATE)
@JsonInclude(JsonInclude.Include.NON_NULL) @JsonInclude(JsonInclude.Include.NON_NULL)
public class Links { public class Links {
@Schema(description = "URL to the first list page", nullable = true) @Schema(description = "URL to the first list page")
private final String first; private final String first;
@Schema(description = "URL to the previous list page", nullable = true) @Schema(description = "URL to the previous list page")
private final String prev; private final String prev;
@Schema(description = "canonical URL for the current list page", nullable = true) @Schema(description = "canonical URL for the current list page")
private final String self; private final String self;
@Schema(description = "URL to the next list page", required = true) @Schema(description = "URL to the next list page", required = true)
private final String next; private final String next;
@Schema(description = "URL to the last list page", nullable = true) @Schema(description = "URL to the last list page")
private final String last; private final String last;
@Schema(description = "URL of a website that presents the object in the browser", nullable = true) @Schema(description = "URL of a website that presents the object in the browser")
private String web; private String web;
} }

30
oparl-server/src/main/java/de/twomartens/oparlservice/entity/Location.java
View File

@ -34,51 +34,51 @@ public class Location {
@Schema(required = true, description = "Date and time of the last update of the object") @Schema(required = true, description = "Date and time of the last update of the object")
private final ZonedDateTime modified; private final ZonedDateTime modified;
@Schema(description = "URL to the license", nullable = true) @Schema(description = "URL to the license")
private String license; private String license;
@Schema(description = "Categorization of the object", nullable = true) @Schema(description = "Categorization of the object")
private String keyword; private String keyword;
@Schema(description = "URL of a website that presents the object in the browser", nullable = true) @Schema(description = "URL of a website that presents the object in the browser")
private String web; private String web;
@Schema(description = "True, if the object was deleted") @Schema(description = "True, if the object was deleted")
private final boolean deleted; private final boolean deleted;
@Schema(description = "description of the location", nullable = true) @Schema(description = "description of the location")
private final String description; private final String description;
@Schema(description = "GeoJSON object of the location", nullable = true) @Schema(description = "GeoJSON object of the location")
private final Object geojson; private final Object geojson;
@Schema(description = "street address of the location", nullable = true) @Schema(description = "street address of the location")
private final String streetAddress; private final String streetAddress;
@Schema(description = "room information of the location", nullable = true) @Schema(description = "room information of the location")
private final String room; private final String room;
@Schema(description = "postal code of the location", nullable = true) @Schema(description = "postal code of the location")
private final String postalCode; private final String postalCode;
@Schema(description = "lower rank locality of the location", nullable = true) @Schema(description = "lower rank locality of the location")
private final String subLocality; private final String subLocality;
@Schema(description = "locality of the location", nullable = true) @Schema(description = "locality of the location")
private final String locality; private final String locality;
@Schema(description = "List of URLS to bodies this location is used for", nullable = true) @Schema(description = "List of URLS to bodies this location is used for")
private final List<String> bodies; private final List<String> bodies;
@Schema(description = "List of URLS to organizations this location is used for", nullable = true) @Schema(description = "List of URLS to organizations this location is used for")
private final List<String> organizations; private final List<String> organizations;
@Schema(description = "List of URLS to persons this location is used for", nullable = true) @Schema(description = "List of URLS to persons this location is used for")
private final List<String> persons; private final List<String> persons;
@Schema(description = "List of URLS to meetings this location is used for", nullable = true) @Schema(description = "List of URLS to meetings this location is used for")
private final List<String> meetings; private final List<String> meetings;
@Schema(description = "List of URLS to papers this location is used for", nullable = true) @Schema(description = "List of URLS to papers this location is used for")
private final List<String> papers; private final List<String> papers;
} }

28
oparl-server/src/main/java/de/twomartens/oparlservice/entity/Meeting.java
View File

@ -34,13 +34,13 @@ public class Meeting {
@Schema(required = true, description = "Date and time of the last update of the object") @Schema(required = true, description = "Date and time of the last update of the object")
private final ZonedDateTime modified; private final ZonedDateTime modified;
@Schema(description = "URL to the license", nullable = true) @Schema(description = "URL to the license")
private String license; private String license;
@Schema(description = "Categorization of the object", nullable = true) @Schema(description = "Categorization of the object")
private String keyword; private String keyword;
@Schema(description = "URL of a website that presents the object in the browser", nullable = true) @Schema(description = "URL of a website that presents the object in the browser")
private String web; private String web;
@Schema(description = "True, if the object was deleted") @Schema(description = "True, if the object was deleted")
@ -50,41 +50,41 @@ public class Meeting {
private final String name; private final String name;
@Schema(type = "string", description = "current status of the meeting", @Schema(type = "string", description = "current status of the meeting",
allowableValues = "terminiert | eingeladen | durchgeführt", nullable = true) allowableValues = "terminiert | eingeladen | durchgeführt")
private final MeetingState meetingState; private final MeetingState meetingState;
@Schema(description = "True if this meeting was cancelled") @Schema(description = "True if this meeting was cancelled")
private final boolean cancelled; private final boolean cancelled;
@JsonFormat(shape = JsonFormat.Shape.STRING) @JsonFormat(shape = JsonFormat.Shape.STRING)
@Schema(description = "date and time of the begin of the meeting", nullable = true) @Schema(description = "date and time of the begin of the meeting")
private final ZonedDateTime start; private final ZonedDateTime start;
@JsonFormat(shape = JsonFormat.Shape.STRING) @JsonFormat(shape = JsonFormat.Shape.STRING)
@Schema(description = "date and time of the end of the meeting", nullable = true) @Schema(description = "date and time of the end of the meeting")
private final ZonedDateTime end; private final ZonedDateTime end;
@Schema(description = "location of the meeting", nullable = true) @Schema(description = "location of the meeting")
private final Location location; private final Location location;
@Schema(description = "List of URLs to organizations that have this meeting", nullable = true) @Schema(description = "List of URLs to organizations that have this meeting")
private final List<String> organization; private final List<String> organization;
@Schema(description = "List of URLs to persons that participated in the meeting", nullable = true) @Schema(description = "List of URLs to persons that participated in the meeting")
private final List<String> participant; private final List<String> participant;
@Schema(description = "invitation document of the meeting", nullable = true) @Schema(description = "invitation document of the meeting")
private final File invitation; private final File invitation;
@Schema(description = "results protocol of the meeting", nullable = true) @Schema(description = "results protocol of the meeting")
private final File resultsProtocol; private final File resultsProtocol;
@Schema(description = "verbatim protocol of the meeting", nullable = true) @Schema(description = "verbatim protocol of the meeting")
private final File verbatimProtocol; private final File verbatimProtocol;
@Schema(description = "List of appendices to the invitation that are not part of agenda items", nullable = true) @Schema(description = "List of appendices to the invitation that are not part of agenda items")
private final List<File> auxiliaryFile; private final List<File> auxiliaryFile;
@Schema(description = "List of agenda items in this meeting. Order is relevant", nullable = true) @Schema(description = "List of agenda items in this meeting. Order is relevant")
private final List<AgendaItem> agendaItem; private final List<AgendaItem> agendaItem;
} }

18
oparl-server/src/main/java/de/twomartens/oparlservice/entity/Membership.java
View File

@ -34,38 +34,38 @@ public class Membership {
@Schema(required = true, description = "Date and time of the last update of the object") @Schema(required = true, description = "Date and time of the last update of the object")
private final ZonedDateTime modified; private final ZonedDateTime modified;
@Schema(description = "URL to the license", nullable = true) @Schema(description = "URL to the license")
private String license; private String license;
@Schema(description = "Categorization of the object", nullable = true) @Schema(description = "Categorization of the object")
private String keyword; private String keyword;
@Schema(description = "URL of a website that presents the object in the browser", nullable = true) @Schema(description = "URL of a website that presents the object in the browser")
private String web; private String web;
@Schema(description = "True, if the object was deleted") @Schema(description = "True, if the object was deleted")
private final boolean deleted; private final boolean deleted;
@Schema(description = "URL to the person related to this membership", nullable = true) @Schema(description = "URL to the person related to this membership")
private final String person; private final String person;
@Schema(description = "URL to the organization related to this membership", nullable = true) @Schema(description = "URL to the organization related to this membership")
private final String organization; private final String organization;
@Schema(description = "role of the person for the organization", nullable = true) @Schema(description = "role of the person for the organization")
private final String role; private final String role;
@Schema(description = "True if the person has a voting right in the organization") @Schema(description = "True if the person has a voting right in the organization")
private final boolean votingRight; private final boolean votingRight;
@JsonFormat(shape = JsonFormat.Shape.STRING) @JsonFormat(shape = JsonFormat.Shape.STRING)
@Schema(description = "first day of the membership", nullable = true) @Schema(description = "first day of the membership")
private final LocalDate startDate; private final LocalDate startDate;
@JsonFormat(shape = JsonFormat.Shape.STRING) @JsonFormat(shape = JsonFormat.Shape.STRING)
@Schema(description = "last day of the membership", nullable = true) @Schema(description = "last day of the membership")
private final LocalDate endDate; private final LocalDate endDate;
@Schema(description = "URL to the organization for which the person is member in the organization", nullable = true) @Schema(description = "URL to the organization for which the person is member in the organization")
private final String onBehalfOf; private final String onBehalfOf;
} }

36
oparl-server/src/main/java/de/twomartens/oparlservice/entity/Organization.java
View File

@ -35,63 +35,63 @@ public class Organization {
@Schema(required = true, description = "Date and time of the last update of the object") @Schema(required = true, description = "Date and time of the last update of the object")
private final ZonedDateTime modified; private final ZonedDateTime modified;
@Schema(description = "URL to the license", nullable = true) @Schema(description = "URL to the license")
private String license; private String license;
@Schema(description = "Categorization of the object", nullable = true) @Schema(description = "Categorization of the object")
private String keyword; private String keyword;
@Schema(description = "URL of a website that presents the object in the browser", nullable = true) @Schema(description = "URL of a website that presents the object in the browser")
private String web; private String web;
@Schema(description = "True, if the object was deleted") @Schema(description = "True, if the object was deleted")
private final boolean deleted; private final boolean deleted;
@Schema(description = "URL to body this legislative term belongs to", nullable = true) @Schema(description = "URL to body this legislative term belongs to")
private final String body; private final String body;
@Schema(description = "official long name of the organization", nullable = true) @Schema(description = "official long name of the organization")
private final String name; private final String name;
@Schema(description = "short name of the organization", nullable = true) @Schema(description = "short name of the organization")
private final String shortName; private final String shortName;
@Schema(description = "List of URLs to memberships", nullable = true) @Schema(description = "List of URLs to memberships")
private final List<String> membership; private final List<String> membership;
@Schema(description = "URL to list of meetings of this organization", nullable = true) @Schema(description = "URL to list of meetings of this organization")
private final String meeting; private final String meeting;
@Schema(description = "URL to list of consultations of this organization", nullable = true) @Schema(description = "URL to list of consultations of this organization")
private final String consultation; private final String consultation;
@Schema(description = "List of positions available in this organization", nullable = true) @Schema(description = "List of positions available in this organization")
private final List<String> post; private final List<String> post;
@Schema(description = "URL to a parent organization", nullable = true) @Schema(description = "URL to a parent organization")
private final String subOrganizationOf; private final String subOrganizationOf;
@Schema(type = "string", description = "rough categorization of the organization", nullable = true, @Schema(type = "string", description = "rough categorization of the organization",
allowableValues = "Gremium | Partei | Fraktion | Verwaltungsbereich | externes Gremium | Institution | Sonstiges") allowableValues = "Gremium | Partei | Fraktion | Verwaltungsbereich | externes Gremium | Institution | Sonstiges")
private final OrganizationType organizationType; private final OrganizationType organizationType;
@Schema(description = "type of organization", nullable = true) @Schema(description = "type of organization")
private final String classification; private final String classification;
@JsonFormat(shape = JsonFormat.Shape.STRING) @JsonFormat(shape = JsonFormat.Shape.STRING)
@Schema(description = "founding date of the organization", nullable = true) @Schema(description = "founding date of the organization")
private final LocalDate startDate; private final LocalDate startDate;
@JsonFormat(shape = JsonFormat.Shape.STRING) @JsonFormat(shape = JsonFormat.Shape.STRING)
@Schema(description = "date of the last day of existance of the organization", nullable = true) @Schema(description = "date of the last day of existance of the organization")
private final LocalDate endDate; private final LocalDate endDate;
@Schema(description = "URL to the website of the organization", nullable = true) @Schema(description = "URL to the website of the organization")
private final String website; private final String website;
@Schema(description = "location of the organization", nullable = true) @Schema(description = "location of the organization")
private final Location location; private final Location location;
@Schema(description = "URL to external OParl body describing this organization", nullable = true) @Schema(description = "URL to external OParl body describing this organization")
private final String externalBody; private final String externalBody;
} }

8
oparl-server/src/main/java/de/twomartens/oparlservice/entity/Pagination.java
View File

@ -12,15 +12,15 @@ import lombok.*;
@NoArgsConstructor(force = true, access = AccessLevel.PRIVATE) @NoArgsConstructor(force = true, access = AccessLevel.PRIVATE)
@JsonInclude(JsonInclude.Include.NON_NULL) @JsonInclude(JsonInclude.Include.NON_NULL)
public class Pagination { public class Pagination {
@Schema(description = "specifies total number of objects in the list", nullable = true) @Schema(description = "specifies total number of objects in the list")
private final int totalElements; private final int totalElements;
@Schema(description = "specifies the number of objects per list page", nullable = true) @Schema(description = "specifies the number of objects per list page")
private final int elementsPerPage; private final int elementsPerPage;
@Schema(description = "specifies the current page number in the list", nullable = true) @Schema(description = "specifies the current page number in the list")
private final int currentPage; private final int currentPage;
@Schema(description = "specifies the total number of pages in the list", nullable = true) @Schema(description = "specifies the total number of pages in the list")
private final int totalPages; private final int totalPages;
} }

36
oparl-server/src/main/java/de/twomartens/oparlservice/entity/Paper.java
View File

@ -35,61 +35,61 @@ public class Paper {
@Schema(required = true, description = "Date and time of the last update of the object") @Schema(required = true, description = "Date and time of the last update of the object")
private final ZonedDateTime modified; private final ZonedDateTime modified;
@Schema(description = "URL to the license", nullable = true) @Schema(description = "URL to the license")
private String license; private String license;
@Schema(description = "Categorization of the object", nullable = true) @Schema(description = "Categorization of the object")
private String keyword; private String keyword;
@Schema(description = "URL of a website that presents the object in the browser", nullable = true) @Schema(description = "URL of a website that presents the object in the browser")
private String web; private String web;
@Schema(description = "True, if the object was deleted") @Schema(description = "True, if the object was deleted")
private final boolean deleted; private final boolean deleted;
@Schema(description = "URL to the body this paper belongs to", nullable = true) @Schema(description = "URL to the body this paper belongs to")
private final String body; private final String body;
@Schema(description = "name of this paper", nullable = true) @Schema(description = "name of this paper")
private final String name; private final String name;
@Schema(description = "official identifier to uniquely identify this paper", nullable = true) @Schema(description = "official identifier to uniquely identify this paper")
private final String reference; private final String reference;
@JsonFormat(shape = JsonFormat.Shape.STRING) @JsonFormat(shape = JsonFormat.Shape.STRING)
@Schema(description = "date which is used, for example, as a reference for deadlines", nullable = true) @Schema(description = "date which is used, for example, as a reference for deadlines")
private final LocalDate date; private final LocalDate date;
@Schema(description = "type of this paper", nullable = true, example = "Beantwortung einer Anfrage") @Schema(description = "type of this paper", example = "Beantwortung einer Anfrage")
private final String paperType; private final String paperType;
@Schema(description = "List of URLs to related papers", nullable = true) @Schema(description = "List of URLs to related papers")
private final List<String> relatedPaper; private final List<String> relatedPaper;
@Schema(description = "List of URLs to superordinate papers", nullable = true) @Schema(description = "List of URLs to superordinate papers")
private final List<String> superordinatedPaper; private final List<String> superordinatedPaper;
@Schema(description = "List of URLs to subordinate papers", nullable = true) @Schema(description = "List of URLs to subordinate papers")
private final List<String> subordinatedPapers; private final List<String> subordinatedPapers;
@Schema(description = "main file for this paper", nullable = true) @Schema(description = "main file for this paper")
private final File mainFile; private final File mainFile;
@Schema(description = "additional files for this paper with exception of mainFile", nullable = true) @Schema(description = "additional files for this paper with exception of mainFile")
private final List<File> auxiliaryFile; private final List<File> auxiliaryFile;
@Schema(description = "List of locations related to this paper", nullable = true) @Schema(description = "List of locations related to this paper")
private final List<Location> location; private final List<Location> location;
@Schema(description = "List of URLs to authors of this paper", nullable = true) @Schema(description = "List of URLs to authors of this paper")
private final List<String> originatorPerson; private final List<String> originatorPerson;
@Schema(description = "List of URLs to organizations that authored this paper", nullable = true) @Schema(description = "List of URLs to organizations that authored this paper")
private final List<String> originatorOrganization; private final List<String> originatorOrganization;
@Schema(description = "List of URLs to organizations responsible for content of or response to this paper", nullable = true) @Schema(description = "List of URLs to organizations responsible for content of or response to this paper")
private final List<String> underDirectionOf; private final List<String> underDirectionOf;
@Schema(description = "List of consultations for this paper", nullable = true) @Schema(description = "List of consultations for this paper")
private final List<Consultation> consultation; private final List<Consultation> consultation;
} }

40
oparl-server/src/main/java/de/twomartens/oparlservice/entity/Person.java
View File

@ -34,66 +34,66 @@ public class Person {
@Schema(required = true, description = "Date and time of the last update of the object") @Schema(required = true, description = "Date and time of the last update of the object")
private final ZonedDateTime modified; private final ZonedDateTime modified;
@Schema(description = "URL to the license", nullable = true) @Schema(description = "URL to the license")
private String license; private String license;
@Schema(description = "Categorization of the object", nullable = true) @Schema(description = "Categorization of the object")
private String keyword; private String keyword;
@Schema(description = "URL of a website that presents the object in the browser", nullable = true) @Schema(description = "URL of a website that presents the object in the browser")
private String web; private String web;
@Schema(description = "True, if the object was deleted") @Schema(description = "True, if the object was deleted")
private final boolean deleted; private final boolean deleted;
@Schema(description = "URL to the body this person belongs so", nullable = true) @Schema(description = "URL to the body this person belongs so")
private final String body; private final String body;
@Schema(description = "full name of this person including academic title", nullable = true) @Schema(description = "full name of this person including academic title")
private final String name; private final String name;
@Schema(description = "family name of this person", nullable = true) @Schema(description = "family name of this person")
private final String familyName; private final String familyName;
@Schema(description = "given name of this person", nullable = true) @Schema(description = "given name of this person")
private final String givenName; private final String givenName;
@Schema(description = "form of address of this person", nullable = true) @Schema(description = "form of address of this person")
private final String formOfAddress; private final String formOfAddress;
@Schema(description = "applicable affix to the name of this person", nullable = true) @Schema(description = "applicable affix to the name of this person")
private final String affix; private final String affix;
@Schema(description = "List of academic titles", nullable = true) @Schema(description = "List of academic titles")
private final List<String> title; private final List<String> title;
@Schema(description = "gender of this person in English", nullable = true, example = "female, male, ...") @Schema(description = "gender of this person in English", example = "female, male, ...")
private final String gender; private final String gender;
@Schema(description = "List of phone number of this person", nullable = true) @Schema(description = "List of phone number of this person")
private final List<String> phone; private final List<String> phone;
@Schema(description = "List of email addresses of this person", nullable = true) @Schema(description = "List of email addresses of this person")
private final List<String> email; private final List<String> email;
@Schema(description = "URL to the contact address of this person", nullable = true) @Schema(description = "URL to the contact address of this person")
private final String location; private final String location;
@Schema(description = "contact address of this person", nullable = true) @Schema(description = "contact address of this person")
private final Location locationObject; private final Location locationObject;
@Schema(description = "List of roles in the body", nullable = true) @Schema(description = "List of roles in the body")
private final List<String> status; private final List<String> status;
@Schema(description = "List of memberships of this person, both current and former", nullable = true) @Schema(description = "List of memberships of this person, both current and former")
private final List<Membership> membership; private final List<Membership> membership;
@Schema(description = "image of this person", nullable = true) @Schema(description = "image of this person")
private final File image; private final File image;
@Schema(description = "short info text about this person", nullable = true, maxLength = 300) @Schema(description = "short info text about this person", maxLength = 300)
private final String life; private final String life;
@Schema(description = "source for the info in life field", nullable = true) @Schema(description = "source for the info in life field")
private final String lifeSource; private final String lifeSource;
} }

20
oparl-server/src/main/java/de/twomartens/oparlservice/entity/System.java
View File

@ -34,13 +34,13 @@ public class System {
@Schema(required = true, description = "Date and time of the last update of the object") @Schema(required = true, description = "Date and time of the last update of the object")
private final ZonedDateTime modified; private final ZonedDateTime modified;
@Schema(description = "URL to the license", nullable = true) @Schema(description = "URL to the license")
private String license; private String license;
@Schema(description = "Categorization of the object", nullable = true) @Schema(description = "Categorization of the object")
private String keyword; private String keyword;
@Schema(description = "URL of a website that presents the object in the browser", nullable = true) @Schema(description = "URL of a website that presents the object in the browser")
private String web; private String web;
@Schema(description = "True, if the object was deleted") @Schema(description = "True, if the object was deleted")
@ -50,28 +50,28 @@ public class System {
@Schema(required = true, description = "URL to the OParl specification supported by this service") @Schema(required = true, description = "URL to the OParl specification supported by this service")
private final String oparlVersion; private final String oparlVersion;
@Schema(description = "Contains a list of URLs to System objects supporting another Oparl version", nullable = true) @Schema(description = "Contains a list of URLs to System objects supporting another Oparl version")
private final List<String> otherOparlVersions; private final List<String> otherOparlVersions;
@NonNull @NonNull
@Schema(required = true, description = "URL to the list of all bodies existing in this system") @Schema(required = true, description = "URL to the list of all bodies existing in this system")
private final String body; private final String body;
@Schema(description = "User friendly name for this system", nullable = true) @Schema(description = "User friendly name for this system")
private final String name; private final String name;
@Schema(description = "E-Mail-Address for requests related to the OParl-API", nullable = true) @Schema(description = "E-Mail-Address for requests related to the OParl-API")
private final String contactEmail; private final String contactEmail;
@Schema(description = "Name of the contact person who can be reached by contactEmail", nullable = true) @Schema(description = "Name of the contact person who can be reached by contactEmail")
private final String contactName; private final String contactName;
@Schema(description = "URL of the website of the parliamentary information system", nullable = true) @Schema(description = "URL of the website of the parliamentary information system")
private final String website; private final String website;
@Schema(description = "URL to the website of the software creator of the OParl server software", nullable = true) @Schema(description = "URL to the website of the software creator of the OParl server software")
private final String vendor; private final String vendor;
@Schema(description = "URL to information about the OParl server software utilized by this system", nullable = true) @Schema(description = "URL to information about the OParl server software utilized by this system")
private final String product; private final String product;
} }