Update SemverRange javadoc

Signed-off-by: Abhilasha Seth <[email protected]>
abseth-amzn · Jan 25, 2024 · 36c6739 · 36c6739
1 parent 901170d
commit 36c6739
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/libs/core/src/main/java/org/opensearch/semver/SemverRange.java b/libs/core/src/main/java/org/opensearch/semver/SemverRange.java
@@ -24,7 +24,13 @@
 import static java.util.Arrays.stream;
 
 /**
- * Represents a single semver range.
+ * Represents a single semver range that allows for specifying which {@code org.opensearch.Version}s satisfy the range.
+ * It is composed of a range version and a range operator. Following are the supported operators:
+ * <ul>
+ *     <li>'=' Requires exact match with the range version. For example, =1.2.3 range would match only 1.2.3</li>
+ *     <li>'~' Allows for patch version variability starting from the range version. For example, ~1.2.3 range would match versions greater than or equal to 1.2.3 but less than 1.3.0</li>
+ *     <li>'^' Allows for patch and minor version variability starting from the range version. For example, ^1.2.3 range would match versions greater than or equal to 1.2.3 but less than 2.0.0</li>
+ * </ul>
  */
 public class SemverRange implements ToXContentFragment {
 

diff --git a/qa/mixed-cluster/src/test/java/org/opensearch/backwards/PluginInfoIT.java b/qa/mixed-cluster/src/test/java/org/opensearch/backwards/PluginInfoIT.java
@@ -8,17 +8,11 @@
 
 package org.opensearch.backwards;
 
-import org.opensearch.Version;
 import org.opensearch.client.Request;
 import org.opensearch.client.Response;
-import org.opensearch.cluster.metadata.IndexMetadata;
-import org.opensearch.common.settings.Settings;
-
 import org.opensearch.test.rest.OpenSearchRestTestCase;
 import org.opensearch.test.rest.yaml.ObjectPath;
 
-import java.util.ArrayList;
-import java.util.List;
 import java.util.Map;
 
 public class PluginInfoIT extends OpenSearchRestTestCase {