mirror/gaps
1
0
Fork 0
mirror of https://github.com/JasonHHouse/gaps.git synced 2026-01-05 18:40:00 -06:00
Code Issues Packages Projects Releases Wiki Activity

More api documentation

Browse Source
This commit is contained in:
Jason House
2020-09-27 18:40:21 +09:00
parent 2ccbd5f59c
commit 0de0544261
6 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Core/src/main/java/com/jasonhhouse/gaps/PlexServer.java
View File

@@ -25,7 +25,7 @@ public final class PlexServer {
private final Set<PlexLibrary> plexLibraries;
@Schema(description = "Human readable way to identify your Plex Server")
private String friendlyName;
@Schema(description = "UUID to identify the Plex Server")
@Schema(description = "UID to identify the Plex Server")
private String machineIdentifier;
@Schema(required = true, description = "Token for your Plex Server. Found via Plex docs.")
private String plexToken;

2
Core/src/main/java/com/jasonhhouse/gaps/properties/DiscordProperties.java
View File

@@ -15,6 +15,7 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.jasonhhouse.gaps.NotificationType;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.Collections;
import java.util.List;
import org.jetbrains.annotations.NotNull;
@@ -25,6 +26,7 @@ import org.jetbrains.annotations.Nullable;
public final class DiscordProperties extends AbstractNotificationProperties {
@NotNull
@Schema(required = true, description = "The full URL of your webhook to the Discord API")
private final String webHookUrl;
@JsonCreator(mode = JsonCreator.Mode.PROPERTIES)

4
Core/src/main/java/com/jasonhhouse/gaps/properties/PushBulletProperties.java
View File

@@ -15,6 +15,7 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.jasonhhouse.gaps.NotificationType;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.Collections;
import java.util.List;
import org.jetbrains.annotations.NotNull;
@@ -23,10 +24,13 @@ import org.jetbrains.annotations.Nullable;
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
public final class PushBulletProperties extends AbstractNotificationProperties {
@NotNull
@Schema(required = true, description = "The channel tag to receive messages")
private final String channel_tag;
@NotNull
@Schema(required = true, description = "The API token connect to PushBullet")
private final String accessToken;
@JsonCreator(mode = JsonCreator.Mode.PROPERTIES)

6
Core/src/main/java/com/jasonhhouse/gaps/properties/PushOverProperties.java
View File

@@ -16,6 +16,7 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.jasonhhouse.gaps.NotificationType;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.Collections;
import java.util.List;
import org.jetbrains.annotations.NotNull;
@@ -26,16 +27,21 @@ import org.jetbrains.annotations.Nullable;
public final class PushOverProperties extends AbstractNotificationProperties {
@NotNull
@Schema(required = true, description = "The API token connect to PushOver")
private final String token;
@NotNull
private final String user;
@NotNull
@Schema(required = true, description = "The priority of the notification. See <a href='https://pushover.net/api#priority'>here</a> for more information.")
private final Integer priority;
@NotNull
@Schema(required = true, description = "The sound of the notification. See <a href='https://pushover.net/api#sounds'>here</a> for more information.")
private final String sound;
@NotNull
@Schema(required = true, description = "The number of times to retry sending the notification. See <a href='https://pushover.net/api#priority'>here</a> for more information.")
private final Integer retry;
@NotNull
@Schema(required = true, description = "The length of time a notification is valid. See <a href='https://pushover.net/api#priority'>here</a> for more information.")
private final Integer expire;
@JsonCreator(mode = JsonCreator.Mode.PROPERTIES)

2
Core/src/main/java/com/jasonhhouse/gaps/properties/SlackProperties.java
View File

@@ -15,6 +15,7 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.jasonhhouse.gaps.NotificationType;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.Collections;
import java.util.List;
import org.jetbrains.annotations.NotNull;
@@ -25,6 +26,7 @@ import org.jetbrains.annotations.Nullable;
public final class SlackProperties extends AbstractNotificationProperties {
@NotNull
@Schema(required = true, description = "The full URL of your webhook to the Slack API")
private final String webHookUrl;
@JsonCreator(mode = JsonCreator.Mode.PROPERTIES)

3
Core/src/main/java/com/jasonhhouse/gaps/properties/TelegramProperties.java
View File

@@ -15,6 +15,7 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.jasonhhouse.gaps.NotificationType;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.Collections;
import java.util.List;
import org.jetbrains.annotations.NotNull;
@@ -25,8 +26,10 @@ import org.jetbrains.annotations.Nullable;
public final class TelegramProperties extends AbstractNotificationProperties {
@NotNull
@Schema(required = true, description = "The UID of your Telegram Bot. Ask BotFather for help about bots.")
private final String botId;
@NotNull
@Schema(required = true, description = "The UID of your own chats. Ask IDBot, /getid")
private final String chatId;
@JsonCreator(mode = JsonCreator.Mode.PROPERTIES)