From 27868ca1e60bbc1ce74dada9ba29a429cbef5a70 Mon Sep 17 00:00:00 2001 From: Hammy Date: Sun, 6 Jun 2021 19:53:17 +0100 Subject: [PATCH] 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 --- .../me/api/entity/series/FilteredSeries.java | 67 ++++++++++++++++--- .../me/api/entity/waifu/FilteredWaifu.java | 65 +++++++++++++----- 2 files changed, 105 insertions(+), 27 deletions(-) diff --git a/src/main/java/org/goudham/me/api/entity/series/FilteredSeries.java b/src/main/java/org/goudham/me/api/entity/series/FilteredSeries.java index 3c30991..27b94b5 100644 --- a/src/main/java/org/goudham/me/api/entity/series/FilteredSeries.java +++ b/src/main/java/org/goudham/me/api/entity/series/FilteredSeries.java @@ -9,7 +9,6 @@ import com.fasterxml.jackson.annotation.JsonPropertyOrder; import java.util.Objects; - /** * {@link FilteredSeries} *

Contains basic series information for most endpoints

@@ -18,9 +17,12 @@ import java.util.Objects; * @@ -30,9 +32,12 @@ import java.util.Objects; @JsonPropertyOrder({ "name", "original_name", + "relevance", "romaji_name", "slug", + "type", "description", + "displayPicture", "url", "id" }) @@ -55,30 +60,52 @@ public class FilteredSeries { 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") - @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; /** - * Readable URL's for this {@link Series} + * Readable URL's for this {@link FilteredSeries} * */ @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; + /** + * 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") - @JsonPropertyDescription("Truncated, spoiler-free description of this Waifu") + @JsonPropertyDescription("Truncated, spoiler-free description of this FilteredSeries") 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 * @@ -88,10 +115,10 @@ public class FilteredSeries { private String url; /** - * Interal ID of this {@link Series} + * Interal ID of this {@link FilteredSeries} */ @JsonProperty("id") - @JsonPropertyDescription("Internal ID of the series") + @JsonPropertyDescription("Internal ID of this FilteredSeries") private Integer id; @JsonProperty("name") @@ -114,6 +141,12 @@ public class FilteredSeries { this.originalName = originalName; } + @JsonProperty("relevance") + public Integer getRelevance() { return relevance; } + + @JsonProperty("relevance") + public void setRelevance(Integer relevance) { this.relevance = relevance; } + @JsonProperty("romaji_name") public String getRomajiName() { return romajiName; @@ -134,6 +167,12 @@ public class FilteredSeries { this.slug = slug; } + @JsonProperty("type") + public String getType() { return type; } + + @JsonProperty("type") + public void setType(String type) { this.type = type; } + @JsonProperty("description") public String getDescription() { return description; @@ -144,6 +183,16 @@ public class FilteredSeries { this.description = description; } + @JsonProperty("display_picture") + public String getDisplayPicture() { + return displayPicture; + } + + @JsonProperty("display_picture") + public void setDisplayPicture(String displayPicture) { + this.displayPicture = displayPicture; + } + @JsonProperty("url") public String getUrl() { return url; diff --git a/src/main/java/org/goudham/me/api/entity/waifu/FilteredWaifu.java b/src/main/java/org/goudham/me/api/entity/waifu/FilteredWaifu.java index ae2a827..5f65923 100644 --- a/src/main/java/org/goudham/me/api/entity/waifu/FilteredWaifu.java +++ b/src/main/java/org/goudham/me/api/entity/waifu/FilteredWaifu.java @@ -1,5 +1,7 @@ package org.goudham.me.api.entity.waifu; +import org.goudham.me.api.entity.series.FilteredSeries; + import java.util.List; import java.util.Objects; import javax.annotation.processing.Generated; @@ -19,13 +21,14 @@ import com.fasterxml.jackson.annotation.JsonPropertyOrder; *
  • {@link String slug}
    • *
  • {@link String name}
    • *
  • {@link String originalName}
    • + *
  • {@link Integer relevance}
    • *
  • {@link String romajiName}
    • *
  • {@link String displayPicture}
    • *
  • {@link Integer likes}
    • *
  • {@link Integer trash}
    • - *
  • {@link Integer episodeCount}
    • + *
  • {@link String type}
    • *
  • {@link String url}
    • - *
  • {@link List} of {@link Appearance}'s
    • + *
  • {@link List} of {@link FilteredSeries}'s
    • *
  • {@link Double id}
    • * * @@ -35,11 +38,13 @@ import com.fasterxml.jackson.annotation.JsonPropertyOrder; "slug", "name", "original_name", + "relevance", "romaji_name", "display_picture", "description", "likes", "trash", + "type", "url", "appearances", "id" @@ -47,11 +52,11 @@ import com.fasterxml.jackson.annotation.JsonPropertyOrder; @Generated("jsonschema2pojo") public class FilteredWaifu { /** - * Used to generate readable URL's for the Waifu + * Used to generate readable URL's for the {@link FilteredWaifu} * */ @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; /** @@ -70,6 +75,13 @@ public class FilteredWaifu { @JsonPropertyDescription("Name in the original language (\u65e5\u672c\u8a9e)") 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. * @@ -87,29 +99,37 @@ public class FilteredWaifu { private String displayPicture; /** - * Truncated, spoiler-free description of this Waifu + * Truncated, spoiler-free description of this {@link FilteredWaifu} * */ @JsonProperty("description") - @JsonPropertyDescription("Truncated, spoiler-free description of this Waifu") + @JsonPropertyDescription("Truncated, spoiler-free description of this FilteredWaifu") private String description; /** - * Number of likes for this Waifu + * Number of likes for this {@link FilteredWaifu} * */ @JsonProperty("likes") - @JsonPropertyDescription("Number of likes for this Waifu") + @JsonPropertyDescription("Number of likes for this FilteredWaifu") private Integer likes; /** - * Number of trashes for this Waifu + * Number of trashes for this {@link FilteredWaifu} * */ @JsonProperty("trash") - @JsonPropertyDescription("Number of trashes for this Waifu") + @JsonPropertyDescription("Number of trashes for this FilteredWaifu") 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 * @@ -119,10 +139,10 @@ public class FilteredWaifu { private String url; /** - *

    {@link List} of Waifu's {@link Appearance}

    + *

    {@link List} of Waifu's appearances

    */ @JsonProperty("appearances") - private List appearances; + private List appearances; /** * {@link FilteredWaifu} ID @@ -140,7 +160,6 @@ public class FilteredWaifu { this.slug = slug; } - @JsonProperty("name") public String getName() { return name; @@ -161,6 +180,12 @@ public class FilteredWaifu { this.originalName = originalName; } + @JsonProperty("relevance") + public Integer getRelevance() { return relevance; } + + @JsonProperty("relevance") + public void setRelevance(Integer relevance) { this.relevance = relevance; } + @JsonProperty("romaji_name") public String getRomajiName() { return romajiName; @@ -211,6 +236,12 @@ public class FilteredWaifu { this.trash = trash; } + @JsonProperty("type") + public String getType() { return type; } + + @JsonProperty("type") + public void setType(String type) { this.type = type; } + @JsonProperty("url") public String getUrl() { return url; @@ -222,13 +253,11 @@ public class FilteredWaifu { } @JsonProperty("appearances") - public List getAppearances() { - return appearances; - } + public List getAppearances() { return appearances; } @JsonProperty("appearances") - public void setAppearances(List appearances) { - this.appearances = appearances; + public void setAppearances(List filteredSeries) { + this.appearances = filteredSeries; } @JsonProperty("id")