docs(postman): update rustman and collection generation docs #3615
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
pixincreate
added
C-doc
pixincreate
changed the title
pixincreate
requested review from
SanchithHegde,
Gnanasundari24 and
likhinbopanna
| @@ -26,10 +26,11 @@ This directory contains the Postman collection for all Hyperswitch supported con | |||
|
|
|||
| - Make sure that you update the `tests` section where the necessary `javascript` code has to written/updated to test the feature (assertion checks where you verify the results obtained with the expected outcome) | |||
| - If certain `tests` need to be run at the time of making a request, make sure you add them to the `Pre-request Script` section of the request | |||
| - Make sure that the request body does not contain any comments else the `newman dir-export` command will fail which is used to export the collection to its directory structure | |||
There was a problem hiding this comment.
Postman does allow using JSON comments in request bodies though:
https://blog.postman.com/introducing-support-for-json-comments-in-request-body/
There was a problem hiding this comment.
Yes, but the dir-export command fails. Might have to check with @knutties to fix it.
SanchithHegde
approved these changes
Feb 12, 2024
likhinbopanna
approved these changes
Feb 13, 2024
pixincreate
removed
the
S-waiting-on-review
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.
Type of Change
Description
This PR updates the
Rustmandocumentation easing the collection development process along with the things to look for before running the collection.Closes #3616
Additional Changes
Motivation and Context
The documentation misses some key points which is why some of the developers and contributors are finding it difficult to test their work.
How did you test it?
Below 2 files look cleaner and clearer:
Checklist
cargo +nightly fmt --allcargo clippy