diff --git a/src/main/java/com/saasquatch/jsonschemainferrer/EnumExtractorInput.java b/src/main/java/com/saasquatch/jsonschemainferrer/EnumExtractorInput.java index fc6b26c..d8ac931 100644 --- a/src/main/java/com/saasquatch/jsonschemainferrer/EnumExtractorInput.java +++ b/src/main/java/com/saasquatch/jsonschemainferrer/EnumExtractorInput.java @@ -41,8 +41,12 @@ public SpecVersion getSpecVersion() { } /** + * This method is marked as {@link Beta @Beta} because it may not be perfect. The algorithm for + * generating JSON path can be found at {@link JunkDrawer#escapeSingleQuoteString}. + * * @return The JSON path of the current traversal. */ + @Beta @Nonnull public String getPath() { return path; diff --git a/src/main/java/com/saasquatch/jsonschemainferrer/FormatInferrerInput.java b/src/main/java/com/saasquatch/jsonschemainferrer/FormatInferrerInput.java index 5631df0..38424b6 100644 --- a/src/main/java/com/saasquatch/jsonschemainferrer/FormatInferrerInput.java +++ b/src/main/java/com/saasquatch/jsonschemainferrer/FormatInferrerInput.java @@ -1,6 +1,7 @@ package com.saasquatch.jsonschemainferrer; import com.fasterxml.jackson.databind.JsonNode; +import com.saasquatch.jsonschemainferrer.annotations.Beta; import javax.annotation.Nonnull; /** @@ -35,8 +36,12 @@ public SpecVersion getSpecVersion() { } /** + * This method is marked as {@link Beta @Beta} because it may not be perfect. The algorithm for + * generating JSON path can be found at {@link JunkDrawer#escapeSingleQuoteString}. + * * @return The JSON path of the current traversal. */ + @Beta @Nonnull public String getPath() { return path;