Skip to content
This repository was archived by the owner on Oct 14, 2024. It is now read-only.

Commit 0fb81cd

Browse files
authored
Add an optional description to Issue (#21)
Since we can't put comments in JSON, this is the next best thing.
1 parent 562d325 commit 0fb81cd

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/main/kotlin/slack/cli/exec/Issue.kt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,18 @@ import com.squareup.moshi.JsonClass
2727
* @property matchingText the matching text to look for in the log.
2828
* @property groupingHash grouping hash for reporting to bugsnag. This should usually be unique, but
2929
* can also be reused across issues that are part of the same general issue.
30+
* @property retrySignal the [RetrySignal] to use when this issue is found.
31+
* @property description an optional description of the issue. Not used in the CLI, just there for
32+
* documentation in the config.
3033
*/
3134
@JsonClass(generateAdapter = true)
3235
internal data class Issue(
3336
val message: String,
3437
@Json(name = "log_message") val logMessage: String,
3538
@Json(name = "matching_text") val matchingText: String,
3639
@Json(name = "grouping_hash") val groupingHash: String,
37-
@Json(name = "retry_signal") val retrySignal: RetrySignal
40+
@Json(name = "retry_signal") val retrySignal: RetrySignal,
41+
val description: String? = null,
3842
) {
3943

4044
private fun List<String>.checkContains(errorText: String): Boolean {

0 commit comments

Comments
 (0)