Skip to content

Commit c0e90f1

Browse files
committed
Mark getPath as beta
1 parent 1111041 commit c0e90f1

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

src/main/java/com/saasquatch/jsonschemainferrer/EnumExtractorInput.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,12 @@ public SpecVersion getSpecVersion() {
4141
}
4242

4343
/**
44+
* This method is marked as {@link Beta @Beta} because it may not be perfect. The algorithm for
45+
* generating JSON path can be found at {@link JunkDrawer#escapeSingleQuoteString}.
46+
*
4447
* @return The JSON path of the current traversal.
4548
*/
49+
@Beta
4650
@Nonnull
4751
public String getPath() {
4852
return path;

src/main/java/com/saasquatch/jsonschemainferrer/FormatInferrerInput.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package com.saasquatch.jsonschemainferrer;
22

33
import com.fasterxml.jackson.databind.JsonNode;
4+
import com.saasquatch.jsonschemainferrer.annotations.Beta;
45
import javax.annotation.Nonnull;
56

67
/**
@@ -35,8 +36,12 @@ public SpecVersion getSpecVersion() {
3536
}
3637

3738
/**
39+
* This method is marked as {@link Beta @Beta} because it may not be perfect. The algorithm for
40+
* generating JSON path can be found at {@link JunkDrawer#escapeSingleQuoteString}.
41+
*
3842
* @return The JSON path of the current traversal.
3943
*/
44+
@Beta
4045
@Nonnull
4146
public String getPath() {
4247
return path;

0 commit comments

Comments
 (0)