MAINT: add json property descriptions for kv configs #4747
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shenkw1
requested review from
chenqi0805,
engechas,
graytaylor0,
dinujoh,
kkondaka,
KarstenSchnitter,
dlvenable and
oeyh
as code owners
oeyh
reviewed
Jul 17, 2024
| private boolean strictGrouping = false; | ||
|
|
||
| @JsonProperty("string_literal_character") | ||
| @JsonPropertyDescription("Can be set to either a single quotation mark (`'`) or a double quotation mark (`\"`). " + |
There was a problem hiding this comment.
This description specifies the valid values but not what this parameter means. I would suggest include the text from the example column (https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/key-value/). Somehow the example text explains what the parameter means in the documentation.
| private String keyValueWhen; | ||
|
|
||
| @JsonProperty("strict_grouping") | ||
| @JsonPropertyDescription("Specifies whether strict grouping should be enabled when the `value_grouping` " + |
There was a problem hiding this comment.
Same here. Let's include the text in the example column as well for this parameter.
shenkw1
force-pushed
the
add-docs-in-json-property-description-for-key-value-processor
branch
2 times, most recently
from
823d156
to
5c68a53
Compare
Signed-off-by: Katherine Shen <katshen@amazon.com>
Signed-off-by: Katherine Shen <katshen@amazon.com>
shenkw1
force-pushed
the
add-docs-in-json-property-description-for-key-value-processor
branch
from
5c68a53
to
2b3c018
Compare
oeyh
previously approved these changes
Jul 18, 2024
dlvenable
previously approved these changes
Jul 18, 2024
|
@shenkw1 , You have a checkstyle error: |
Signed-off-by: Katherine Shen <katshen@amazon.com>
oeyh
approved these changes
Jul 19, 2024
dlvenable
approved these changes
Jul 19, 2024
kkondaka
pushed a commit
to kkondaka/kk-data-prepper-f2
that referenced
this pull request
Jul 23, 2024
…ect#4747) add json property descriptions for kv configs Signed-off-by: Katherine Shen <katshen@amazon.com> Signed-off-by: Krishna Kondaka <krishkdk@dev-dsk-krishkdk-2c-bd29c437.us-west-2.amazon.com>
kkondaka
pushed a commit
to kkondaka/kk-data-prepper-f2
that referenced
this pull request
Jul 23, 2024
…ect#4747) add json property descriptions for kv configs Signed-off-by: Katherine Shen <katshen@amazon.com> Signed-off-by: Krishna Kondaka <krishkdk@dev-dsk-krishkdk-2c-bd29c437.us-west-2.amazon.com>
kkondaka
pushed a commit
to kkondaka/kk-data-prepper-f2
that referenced
this pull request
Jul 23, 2024
…ect#4747) add json property descriptions for kv configs Signed-off-by: Katherine Shen <katshen@amazon.com> Signed-off-by: Krishna Kondaka <krishkdk@dev-dsk-krishkdk-2c-bd29c437.us-west-2.amazon.com>
kkondaka
pushed a commit
to kkondaka/kk-data-prepper-f2
that referenced
this pull request
Jul 30, 2024
…ect#4747) add json property descriptions for kv configs Signed-off-by: Katherine Shen <katshen@amazon.com> Signed-off-by: Krishna Kondaka <krishkdk@dev-dsk-krishkdk-2c-bd29c437.us-west-2.amazon.com>
kkondaka
pushed a commit
to kkondaka/kk-data-prepper-f2
that referenced
this pull request
Aug 8, 2024
…ect#4747) add json property descriptions for kv configs Signed-off-by: Katherine Shen <katshen@amazon.com> Signed-off-by: Krishna Kondaka <krishkdk@dev-dsk-krishkdk-2c-bd29c437.us-west-2.amazon.com>
kkondaka
pushed a commit
to kkondaka/kk-data-prepper-f2
that referenced
this pull request
Aug 12, 2024
…ect#4747) add json property descriptions for kv configs Signed-off-by: Katherine Shen <katshen@amazon.com> Signed-off-by: Krishna Kondaka <krishkdk@dev-dsk-krishkdk-2c-bd29c437.us-west-2.amazon.com>
kkondaka
pushed a commit
to kkondaka/kk-data-prepper-f2
that referenced
this pull request
Aug 14, 2024
…ect#4747) add json property descriptions for kv configs Signed-off-by: Katherine Shen <katshen@amazon.com> Signed-off-by: Krishna Kondaka <krishkdk@dev-dsk-krishkdk-2c-bd29c437.us-west-2.amazon.com>
shenkw1
deleted the
add-docs-in-json-property-description-for-key-value-processor
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR serves as the starter for plugin config table into @JsonPropertyDescription so that a complete JSON schema can be generated for the Key-Value Processor.
Issues Resolved
Resolves #[Issue number to be closed when this PR is merged]
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.