Update documentation & add new fields

The API was returning fields that were not specified in the API reference, the classes have been updated to reflect the actual API response
pull/6/head
Hammy 4 years ago
parent 7530afa182
commit 27868ca1e6

@ -9,7 +9,6 @@ import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import java.util.Objects; import java.util.Objects;
/** /**
* {@link FilteredSeries} * {@link FilteredSeries}
* <p> Contains basic series information for most endpoints </p> * <p> Contains basic series information for most endpoints </p>
@ -18,9 +17,12 @@ import java.util.Objects;
* <ul> * <ul>
* <li>{@link String name}</li> * <li>{@link String name}</li>
* <li>{@link String originalName}</li> * <li>{@link String originalName}</li>
* <li>{@link Integer relevance}</li>
* <li>{@link String romajiName}</li> * <li>{@link String romajiName}</li>
* <li>{@link String slug}</li> * <li>{@link String slug}</li>
* <li>{@link String} type</li>
* <li>{@link String description}</li> * <li>{@link String description}</li>
* <li>{@link String displayPicture}</li>
* <li>{@link String url}</li> * <li>{@link String url}</li>
* <li>{@link Integer id}</li> * <li>{@link Integer id}</li>
* </ul> * </ul>
@ -30,9 +32,12 @@ import java.util.Objects;
@JsonPropertyOrder({ @JsonPropertyOrder({
"name", "name",
"original_name", "original_name",
"relevance",
"romaji_name", "romaji_name",
"slug", "slug",
"type",
"description", "description",
"displayPicture",
"url", "url",
"id" "id"
}) })
@ -55,30 +60,52 @@ public class FilteredSeries {
private String originalName; private String originalName;
/** /**
* If this {@link Series} has a romaji name, we'll put it here. * Relevancy of {@link FilteredSeries}
*/
@JsonProperty("relevance")
@JsonPropertyDescription("Relevancy of FilteredSeries")
private Integer relevance;
/**
* If this {@link FilteredSeries} has a romaji name, we'll put it here.
* *
*/ */
@JsonProperty("romaji_name") @JsonProperty("romaji_name")
@JsonPropertyDescription("if this character has a romaji name, we'll put it here. ") @JsonPropertyDescription("if this series has a romaji name, we'll put it here. ")
private String romajiName; private String romajiName;
/** /**
* Readable URL's for this {@link Series} * Readable URL's for this {@link FilteredSeries}
* *
*/ */
@JsonProperty("slug") @JsonProperty("slug")
@JsonPropertyDescription("Used to generate readable URL's for the Waifu") @JsonPropertyDescription("Used to generate readable URL's for the FilteredSeries")
private String slug; private String slug;
/**
* Type of {@link FilteredSeries}. E.g TV, Game
*
*/
@JsonProperty("type")
@JsonPropertyDescription("Type of FilteredSeries. E.g TV, Game")
private String type;
/** /**
* Truncated, spoiler-free description of this {@link Series} * Truncated, spoiler-free description of this {@link FilteredSeries}
* *
*/ */
@JsonProperty("description") @JsonProperty("description")
@JsonPropertyDescription("Truncated, spoiler-free description of this Waifu") @JsonPropertyDescription("Truncated, spoiler-free description of this FilteredSeries")
private String description; private String description;
/**
* URL of the display picture
*
*/
@JsonProperty("display_picture")
@JsonPropertyDescription("URL of the display picture")
private String displayPicture;
/** /**
* URL to view in browser * URL to view in browser
* *
@ -88,10 +115,10 @@ public class FilteredSeries {
private String url; private String url;
/** /**
* Interal ID of this {@link Series} * Interal ID of this {@link FilteredSeries}
*/ */
@JsonProperty("id") @JsonProperty("id")
@JsonPropertyDescription("Internal ID of the series") @JsonPropertyDescription("Internal ID of this FilteredSeries")
private Integer id; private Integer id;
@JsonProperty("name") @JsonProperty("name")
@ -114,6 +141,12 @@ public class FilteredSeries {
this.originalName = originalName; this.originalName = originalName;
} }
@JsonProperty("relevance")
public Integer getRelevance() { return relevance; }
@JsonProperty("relevance")
public void setRelevance(Integer relevance) { this.relevance = relevance; }
@JsonProperty("romaji_name") @JsonProperty("romaji_name")
public String getRomajiName() { public String getRomajiName() {
return romajiName; return romajiName;
@ -134,6 +167,12 @@ public class FilteredSeries {
this.slug = slug; this.slug = slug;
} }
@JsonProperty("type")
public String getType() { return type; }
@JsonProperty("type")
public void setType(String type) { this.type = type; }
@JsonProperty("description") @JsonProperty("description")
public String getDescription() { public String getDescription() {
return description; return description;
@ -144,6 +183,16 @@ public class FilteredSeries {
this.description = description; this.description = description;
} }
@JsonProperty("display_picture")
public String getDisplayPicture() {
return displayPicture;
}
@JsonProperty("display_picture")
public void setDisplayPicture(String displayPicture) {
this.displayPicture = displayPicture;
}
@JsonProperty("url") @JsonProperty("url")
public String getUrl() { public String getUrl() {
return url; return url;

@ -1,5 +1,7 @@
package org.goudham.me.api.entity.waifu; package org.goudham.me.api.entity.waifu;
import org.goudham.me.api.entity.series.FilteredSeries;
import java.util.List; import java.util.List;
import java.util.Objects; import java.util.Objects;
import javax.annotation.processing.Generated; import javax.annotation.processing.Generated;
@ -19,13 +21,14 @@ import com.fasterxml.jackson.annotation.JsonPropertyOrder;
* <li>{@link String slug}</li> * <li>{@link String slug}</li>
* <li>{@link String name}</li> * <li>{@link String name}</li>
* <li>{@link String originalName}</li> * <li>{@link String originalName}</li>
* <li>{@link Integer relevance}</li>
* <li>{@link String romajiName}</li> * <li>{@link String romajiName}</li>
* <li>{@link String displayPicture}</li> * <li>{@link String displayPicture}</li>
* <li>{@link Integer likes}</li> * <li>{@link Integer likes}</li>
* <li>{@link Integer trash}</li> * <li>{@link Integer trash}</li>
* <li>{@link Integer episodeCount}</li> * <li>{@link String type}</li>
* <li>{@link String url}</li> * <li>{@link String url}</li>
* <li>{@link List} of {@link Appearance}'s</li> * <li>{@link List} of {@link FilteredSeries}'s</li>
* <li>{@link Double id}</li> * <li>{@link Double id}</li>
* </ul> * </ul>
* *
@ -35,11 +38,13 @@ import com.fasterxml.jackson.annotation.JsonPropertyOrder;
"slug", "slug",
"name", "name",
"original_name", "original_name",
"relevance",
"romaji_name", "romaji_name",
"display_picture", "display_picture",
"description", "description",
"likes", "likes",
"trash", "trash",
"type",
"url", "url",
"appearances", "appearances",
"id" "id"
@ -47,11 +52,11 @@ import com.fasterxml.jackson.annotation.JsonPropertyOrder;
@Generated("jsonschema2pojo") @Generated("jsonschema2pojo")
public class FilteredWaifu { public class FilteredWaifu {
/** /**
* Used to generate readable URL's for the Waifu * Used to generate readable URL's for the {@link FilteredWaifu}
* *
*/ */
@JsonProperty("slug") @JsonProperty("slug")
@JsonPropertyDescription("Used to generate readable URL's for the Waifu") @JsonPropertyDescription("Used to generate readable URL's for the FilteredWaifu")
private String slug; private String slug;
/** /**
@ -70,6 +75,13 @@ public class FilteredWaifu {
@JsonPropertyDescription("Name in the original language (\u65e5\u672c\u8a9e)") @JsonPropertyDescription("Name in the original language (\u65e5\u672c\u8a9e)")
private String originalName; private String originalName;
/**
* Relevancy of {@link FilteredWaifu}
*/
@JsonProperty("relevance")
@JsonPropertyDescription("Relevancy of FilteredWaifu")
private Integer relevance;
/** /**
* If this character has a romaji name, we'll put it here. * If this character has a romaji name, we'll put it here.
* *
@ -87,29 +99,37 @@ public class FilteredWaifu {
private String displayPicture; private String displayPicture;
/** /**
* Truncated, spoiler-free description of this Waifu * Truncated, spoiler-free description of this {@link FilteredWaifu}
* *
*/ */
@JsonProperty("description") @JsonProperty("description")
@JsonPropertyDescription("Truncated, spoiler-free description of this Waifu") @JsonPropertyDescription("Truncated, spoiler-free description of this FilteredWaifu")
private String description; private String description;
/** /**
* Number of likes for this Waifu * Number of likes for this {@link FilteredWaifu}
* *
*/ */
@JsonProperty("likes") @JsonProperty("likes")
@JsonPropertyDescription("Number of likes for this Waifu") @JsonPropertyDescription("Number of likes for this FilteredWaifu")
private Integer likes; private Integer likes;
/** /**
* Number of trashes for this Waifu * Number of trashes for this {@link FilteredWaifu}
* *
*/ */
@JsonProperty("trash") @JsonProperty("trash")
@JsonPropertyDescription("Number of trashes for this Waifu") @JsonPropertyDescription("Number of trashes for this FilteredWaifu")
private Integer trash; private Integer trash;
/**
* Type that is returned. Eg Waifu, Husbando
*
*/
@JsonProperty("type")
@JsonPropertyDescription("Type that is returned. Eg Waifu, Husbando")
private String type;
/** /**
* URL to view in browser * URL to view in browser
* *
@ -119,10 +139,10 @@ public class FilteredWaifu {
private String url; private String url;
/** /**
* <p>{@link List<Appearance>} of Waifu's {@link Appearance}</p> * <p>{@link List} of Waifu's appearances</p>
*/ */
@JsonProperty("appearances") @JsonProperty("appearances")
private List<Appearance> appearances; private List<FilteredSeries> appearances;
/** /**
* {@link FilteredWaifu} ID * {@link FilteredWaifu} ID
@ -140,7 +160,6 @@ public class FilteredWaifu {
this.slug = slug; this.slug = slug;
} }
@JsonProperty("name") @JsonProperty("name")
public String getName() { public String getName() {
return name; return name;
@ -161,6 +180,12 @@ public class FilteredWaifu {
this.originalName = originalName; this.originalName = originalName;
} }
@JsonProperty("relevance")
public Integer getRelevance() { return relevance; }
@JsonProperty("relevance")
public void setRelevance(Integer relevance) { this.relevance = relevance; }
@JsonProperty("romaji_name") @JsonProperty("romaji_name")
public String getRomajiName() { public String getRomajiName() {
return romajiName; return romajiName;
@ -211,6 +236,12 @@ public class FilteredWaifu {
this.trash = trash; this.trash = trash;
} }
@JsonProperty("type")
public String getType() { return type; }
@JsonProperty("type")
public void setType(String type) { this.type = type; }
@JsonProperty("url") @JsonProperty("url")
public String getUrl() { public String getUrl() {
return url; return url;
@ -222,13 +253,11 @@ public class FilteredWaifu {
} }
@JsonProperty("appearances") @JsonProperty("appearances")
public List<Appearance> getAppearances() { public List<FilteredSeries> getAppearances() { return appearances; }
return appearances;
}
@JsonProperty("appearances") @JsonProperty("appearances")
public void setAppearances(List<Appearance> appearances) { public void setAppearances(List<FilteredSeries> filteredSeries) {
this.appearances = appearances; this.appearances = filteredSeries;
} }
@JsonProperty("id") @JsonProperty("id")

Loading…
Cancel
Save