From 2cb9747e5630a04f7dcd779af12c047a8be91e80 Mon Sep 17 00:00:00 2001
From: David Huang <huangxwabc@gmail.com>
Date: Wed, 23 Mar 2022 21:15:36 +0800
Subject: [PATCH] doc: Improve javadoc for DegradeRule and dashboard
 ApiPredicateItemVo (#2614)

---
 .../sentinel/slots/block/degrade/DegradeRule.java  | 14 +++++++++++++-
 .../domain/vo/gateway/api/ApiPredicateItemVo.java  | 12 ++++++++++++
 2 files changed, 25 insertions(+), 1 deletion(-)

diff --git a/sentinel-core/src/main/java/com/alibaba/csp/sentinel/slots/block/degrade/DegradeRule.java b/sentinel-core/src/main/java/com/alibaba/csp/sentinel/slots/block/degrade/DegradeRule.java
index edc9f1b3..3f2bd650 100755
--- a/sentinel-core/src/main/java/com/alibaba/csp/sentinel/slots/block/degrade/DegradeRule.java
+++ b/sentinel-core/src/main/java/com/alibaba/csp/sentinel/slots/block/degrade/DegradeRule.java
@@ -59,7 +59,12 @@ public class DegradeRule extends AbstractRule {
     private int grade = RuleConstant.DEGRADE_GRADE_RT;
 
     /**
-     * Threshold count.
+     * Threshold count. The exact meaning depends on the field of grade.
+     * <ul>
+     *     <li>In average RT mode, it means the maximum response time(RT) in milliseconds.</li>
+     *     <li>In exception ratio mode, it means exception ratio which between 0.0 and 1.0.</li>
+     *     <li>In exception count mode, it means exception count</li>
+     * <ul/>
      */
     private double count;
 
@@ -78,9 +83,16 @@ public class DegradeRule extends AbstractRule {
 
     /**
      * The threshold of slow request ratio in RT mode.
+     *
+     * @since 1.8.0
      */
     private double slowRatioThreshold = 1.0d;
 
+    /**
+     * The interval statistics duration in millisecond.
+     *
+     * @since 1.8.0
+     */
     private int statIntervalMs = 1000;
 
     public int getGrade() {
diff --git a/sentinel-dashboard/src/main/java/com/alibaba/csp/sentinel/dashboard/domain/vo/gateway/api/ApiPredicateItemVo.java b/sentinel-dashboard/src/main/java/com/alibaba/csp/sentinel/dashboard/domain/vo/gateway/api/ApiPredicateItemVo.java
index d621ddf5..3fd87883 100644
--- a/sentinel-dashboard/src/main/java/com/alibaba/csp/sentinel/dashboard/domain/vo/gateway/api/ApiPredicateItemVo.java
+++ b/sentinel-dashboard/src/main/java/com/alibaba/csp/sentinel/dashboard/domain/vo/gateway/api/ApiPredicateItemVo.java
@@ -23,8 +23,20 @@ package com.alibaba.csp.sentinel.dashboard.domain.vo.gateway.api;
  */
 public class ApiPredicateItemVo {
 
+    /**
+     * The pattern for matching url.
+     */
     private String pattern;
 
+    /**
+     * The matching Strategy in url. Constants are defined in class SentinelGatewayConstants.\
+     *
+     * <ul>
+     *     <li>0(URL_MATCH_STRATEGY_EXACT): exact match mode</li>
+     *     <li>1(URL_MATCH_STRATEGY_PREFIX): prefix match mode</li>
+     *     <li>2(URL_MATCH_STRATEGY_REGEX): regex match mode</li>
+     * </ul>
+     */
     private Integer matchStrategy;
 
     public String getPattern() {