Skip to content

Commit

Permalink
Link JsonPath parameter descriptions to our documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sambsnyd committed Jul 31, 2024
1 parent 52c87ad commit 0ed38dc
Show file tree
Hide file tree
Showing 10 changed files with 13 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
@EqualsAndHashCode(callSuper = false)
public class ChangeKey extends Recipe {
@Option(displayName = "Old key path",
description = "A JsonPath expression to locate a JSON entry.",
description = "A [JsonPath](https://docs.openrewrite.org/reference/jsonpath-and-jsonpathmatcher-reference) expression to locate a JSON entry.",
example = "$.subjects.kind")
String oldKeyPath;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
@EqualsAndHashCode(callSuper = false)
public class ChangeValue extends Recipe {
@Option(displayName = "Key path",
description = "A JsonPath expression to locate a JSON entry.",
description = "A [JsonPath](https://docs.openrewrite.org/reference/jsonpath-and-jsonpathmatcher-reference) expression to locate a JSON entry.",
example = "$.subjects.kind")
String oldKeyPath;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@
@Value
@EqualsAndHashCode(callSuper = false)
public class DeleteKey extends Recipe {

@Option(displayName = "Key path",
description = "A JsonPath expression to locate a JSON entry.",
description = "A [JsonPath](https://docs.openrewrite.org/reference/jsonpath-and-jsonpathmatcher-reference) expression to locate a JSON entry.",
example = "$.subjects.kind")
String keyPath;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@
@Value
@EqualsAndHashCode(callSuper = false)
public class AppendToSequence extends Recipe {
@Option(displayName = "sequence path",
description = "A [JsonPath](https://github.com/json-path/JsonPath) expression to locate a YAML sequence.",
@Option(displayName = "Sequence path",
description = "A [JsonPath](https://docs.openrewrite.org/reference/jsonpath-and-jsonpathmatcher-reference) expression to locate a YAML sequence.",
example = "$.universe.planets")
String sequencePath;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
@EqualsAndHashCode(callSuper = false)
public class ChangeKey extends Recipe {
@Option(displayName = "Old key path",
description = "A [JsonPath](https://github.com/json-path/JsonPath) expression to locate a YAML entry.",
description = "A [JsonPath](https://docs.openrewrite.org/reference/jsonpath-and-jsonpathmatcher-reference) expression to locate a YAML entry.",
example = "$.subjects.kind")
String oldKeyPath;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
@EqualsAndHashCode(callSuper = false)
public class ChangeValue extends Recipe {
@Option(displayName = "Key path",
description = "A [JsonPath](https://github.com/json-path/JsonPath) expression to locate a YAML entry.",
description = "A [JsonPath](https://docs.openrewrite.org/reference/jsonpath-and-jsonpathmatcher-reference) expression to locate a YAML entry.",
example = "$.subjects.kind")
String keyPath;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
@EqualsAndHashCode(callSuper = false)
public class CopyValue extends ScanningRecipe<CopyValue.Accumulator> {
@Option(displayName = "Old key path",
description = "A [JsonPath](https://github.com/json-path/JsonPath) expression to locate a YAML key/value pair to copy.",
description = "A [JsonPath](https://docs.openrewrite.org/reference/jsonpath-and-jsonpathmatcher-reference) expression to locate a YAML key/value pair to copy.",
example = "$.source.kind")
String oldKeyPath;

Expand All @@ -42,7 +42,7 @@ public class CopyValue extends ScanningRecipe<CopyValue.Accumulator> {
String oldFilePath;

@Option(displayName = "New key path",
description = "A [JsonPath](https://github.com/json-path/JsonPath) expression defining where the value should be written.",
description = "A [JsonPath](https://docs.openrewrite.org/reference/jsonpath-and-jsonpathmatcher-reference) expression defining where the value should be written.",
example = "$.dest.kind")
String newKey;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
@EqualsAndHashCode(callSuper = false)
public class DeleteKey extends Recipe {
@Option(displayName = "Key path",
description = "A [JsonPath](https://github.com/json-path/JsonPath) expression to locate a YAML entry.",
description = "A [JsonPath](https://docs.openrewrite.org/reference/jsonpath-and-jsonpathmatcher-reference) expression to locate a YAML entry.",
example = "$.source.kind")
String keyPath;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
@EqualsAndHashCode(callSuper = false)
public class MergeYaml extends Recipe {
@Option(displayName = "Key path",
description = "A [JsonPath](https://github.com/json-path/JsonPath) expression used to find matching keys.",
description = "A [JsonPath](https://docs.openrewrite.org/reference/jsonpath-and-jsonpathmatcher-reference) expression used to find matching keys.",
example = "$.metadata")
String key;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public String getDisplayName() {

@Override
public String getDescription() {
return "Find YAML entries that match the specified [JsonPath](https://github.com/json-path/JsonPath) expression.";
return "Find YAML entries that match the specified [JsonPath](https://docs.openrewrite.org/reference/jsonpath-and-jsonpathmatcher-reference) expression.";
}

@Override
Expand Down

0 comments on commit 0ed38dc

Please sign in to comment.