Un-hid 'web.github.connection-interval' in config.yml

This commit is contained in:
Florian CUNY 2019-04-20 12:01:29 +02:00
parent 70f589538c
commit 8fcbdc716e
2 changed files with 8 additions and 1 deletions

View File

@ -181,7 +181,7 @@ public class Settings implements DataObject {
@ConfigComment("However, as the GitHub API data does not get updated instantly, it is recommended to keep")
@ConfigComment("this value greater than 15 minutes.")
@ConfigComment("Setting this to 0 will make BentoBox download data only at startup.")
@ConfigEntry(path = "web.github.connection-interval", since = "1.3.0", hidden = true)
@ConfigEntry(path = "web.github.connection-interval", since = "1.5.0")
private int githubConnectionInterval = 60;
@ConfigComment("Toggle whether the downloaded data should be flushed to files.")

View File

@ -91,6 +91,13 @@ web:
# It does not send any data.
# Added since 1.5.0.
download-data: true
# Time in minutes between each connection to the GitHub API.
# This allows for up-to-the-minute information gathering.
# However, as the GitHub API data does not get updated instantly, it is recommended to keep
# this value greater than 15 minutes.
# Setting this to 0 will make BentoBox download data only at startup.
# Added since 1.5.0.
connection-interval: 60
# Toggle whether the downloaded data should be flushed to files.
# It helps to prevent previously downloaded data being lost due to a more recent connection that failed
# to connect to the GitHub API.