feat: add docs for metadata in config file#598
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the new --metadata flag for the keploy record command, providing users with examples and usage details for adding key-value metadata entries in the config file.
- Updated the CLI commands table to include the --metadata flag.
- Added detailed usage examples and description for the --metadata flag.
Comments suppressed due to low confidence (1)
versioned_docs/version-3.0.0/running-keploy/cli-commands.md:75
- [nitpick] Consider clarifying the expected format for metadata key-value pairs, including details on separators, escaping rules (if any), and allowed characters, to help users avoid input errors.
- `--metadata string` - Key-value pairs to be added as metadata in the config.yaml file. If a `name` key is provided, it will be used as the test set name.
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
3e4b5be to
994c2f1
Compare
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
4d69170 to
3ba581e
Compare
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
This file contains hidden or 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
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.
What has changed?
Please include a summary of the change.
This PR Resolves keploy/keploy#2817
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please run npm run build and npm run serve to check if the changes are working as expected. Please include screenshots of the output of both the commands. Add screenshots/gif of the changes if possible.
Checklist: