Skip to content

Commit

Permalink
chore: Update default values in Tracker exporters OpenAPI [TECH-1580]
Browse files Browse the repository at this point in the history
  • Loading branch information
enricocolasante committed Nov 16, 2023
1 parent 0995a6d commit 516dfc2
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,22 @@
*/
package org.hisp.dhis.tracker.export;

import java.util.Objects;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.ToString;

/** {@link PageParams} represent the parameters that configure the page of items to be returned. */
/**
* {@link PageParams} represent the parameters that configure the page of items to be returned. By
* default, the total number of items will not be fetched.
*/
@Getter
@ToString
@EqualsAndHashCode
public class PageParams {
private static final int DEFAULT_PAGE = 1;
private static final int DEFAULT_PAGE_SIZE = 50;

/** The page number to be returned. */
final int page;

Expand All @@ -46,8 +53,8 @@ public class PageParams {
final boolean pageTotal;

public PageParams(Integer page, Integer pageSize, Boolean pageTotal) {
this.page = page;
this.pageSize = pageSize;
this.page = Objects.requireNonNullElse(page, DEFAULT_PAGE);
this.pageSize = Objects.requireNonNullElse(pageSize, DEFAULT_PAGE_SIZE);
this.pageTotal = Boolean.TRUE.equals(pageTotal);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,22 @@
import org.hisp.dhis.webapi.controller.tracker.view.TrackedEntity;

/** Represents query parameters sent to {@link EnrollmentsExportController}. */
@OpenApi.Shared(name = "EnrollmentRequestParams")
@OpenApi.Property
@Data
@NoArgsConstructor
public class EnrollmentRequestParams implements PageRequestParams {
static final String DEFAULT_FIELDS_PARAM = "*,!relationships,!events,!attributes";

private Integer page = 1;
private Integer pageSize = 50;
@OpenApi.Property(defaultValue = "1")
private Integer page;

@OpenApi.Property(defaultValue = "50")
private Integer pageSize;

@OpenApi.Property(defaultValue = "false")
private Boolean totalPages = false;

Check notice

Code scanning / CodeQL

Missing Override annotation Note

This method overrides
PageRequestParams.getTotalPages
; it is advisable to add an Override annotation.

private Boolean skipPaging = false;

Check notice

Code scanning / CodeQL

Missing Override annotation Note

This method overrides
PageRequestParams.getSkipPaging
; it is advisable to add an Override annotation.

private List<OrderCriteria> order = new ArrayList<>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,22 @@
*
* @author Giuseppe Nespolino <[email protected]>
*/
@OpenApi.Shared(name = "EventRequestParams")
@OpenApi.Property
@Data
@NoArgsConstructor
public class EventRequestParams implements PageRequestParams {
static final String DEFAULT_FIELDS_PARAM = "*,!relationships";

private Integer page = 1;
private Integer pageSize = 50;
@OpenApi.Property(defaultValue = "1")
private Integer page;

@OpenApi.Property(defaultValue = "50")
private Integer pageSize;

@OpenApi.Property(defaultValue = "false")
private Boolean totalPages = false;

Check notice

Code scanning / CodeQL

Missing Override annotation Note

This method overrides
PageRequestParams.getTotalPages
; it is advisable to add an Override annotation.

private Boolean skipPaging = false;

Check notice

Code scanning / CodeQL

Missing Override annotation Note

This method overrides
PageRequestParams.getSkipPaging
; it is advisable to add an Override annotation.

private List<OrderCriteria> order = new ArrayList<>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,23 @@
import org.hisp.dhis.webapi.controller.tracker.view.Event;
import org.hisp.dhis.webapi.controller.tracker.view.TrackedEntity;

@OpenApi.Shared(name = "RelationshipRequestParams")
@OpenApi.Property
@Data
@NoArgsConstructor
public class RelationshipRequestParams implements PageRequestParams {
static final String DEFAULT_FIELDS_PARAM =
"relationship,relationshipType,createdAtClient,from[trackedEntity[trackedEntity],enrollment[enrollment],event[event]],to[trackedEntity[trackedEntity],enrollment[enrollment],event[event]]";

private Integer page = 1;
private Integer pageSize = 50;
@OpenApi.Property(defaultValue = "1")
private Integer page;

@OpenApi.Property(defaultValue = "50")
private Integer pageSize;

@OpenApi.Property(defaultValue = "false")
private Boolean totalPages = false;

Check notice

Code scanning / CodeQL

Missing Override annotation Note

This method overrides
PageRequestParams.getTotalPages
; it is advisable to add an Override annotation.

private Boolean skipPaging = false;

Check notice

Code scanning / CodeQL

Missing Override annotation Note

This method overrides
PageRequestParams.getSkipPaging
; it is advisable to add an Override annotation.

private List<OrderCriteria> order = new ArrayList<>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,22 @@
*
* @author Giuseppe Nespolino
*/
@OpenApi.Shared(name = "TrackedEntityRequestParams")
@OpenApi.Property
@Data
@NoArgsConstructor
public class TrackedEntityRequestParams implements PageRequestParams {
static final String DEFAULT_FIELDS_PARAM = "*,!relationships,!enrollments,!events,!programOwners";

private Integer page = 1;
private Integer pageSize = 50;
@OpenApi.Property(defaultValue = "1")
private Integer page;

@OpenApi.Property(defaultValue = "50")
private Integer pageSize;

@OpenApi.Property(defaultValue = "false")
private Boolean totalPages = false;

Check notice

Code scanning / CodeQL

Missing Override annotation Note

This method overrides
PageRequestParams.getTotalPages
; it is advisable to add an Override annotation.

private Boolean skipPaging = false;

Check notice

Code scanning / CodeQL

Missing Override annotation Note

This method overrides
PageRequestParams.getSkipPaging
; it is advisable to add an Override annotation.

private List<OrderCriteria> order = new ArrayList<>();
Expand Down

0 comments on commit 516dfc2

Please sign in to comment.