docs(openapi): add postman warning #851
Draft
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
…x-364-create-a-warning-in-rdme-when-someone-works-with-a-postman
…-someone-works-with-a-postman
…-someone-works-with-a-postman
kanadgupta
requested changes
Oct 2, 2023
There was a problem hiding this comment.
great work so far, for real! the code is in the exact spot it should be and you've absolutely nailed the logic — i have a few small suggestions below, and i think it might be good to add a test to ensure that it shows up when we want it to. happy to pair on this!
| ); | ||
| break; | ||
| default: | ||
| debug(`Type ${chalk.yellow('rdme help')} to see all commands`); |
There was a problem hiding this comment.
don't think you need this debug statement, mind removing it?
| switch (command) { | ||
| case 'openapi': | ||
| warn( | ||
| 'You are attempting to upload a Postman collection. This feature is currently experimental. For more information, visit our docs here: https://docs.readme.com/main/docs/openapi#the-api-reference', |
There was a problem hiding this comment.
small refactoring suggestion: mind creating a separate variable above (called postmanWarning or something like that) and re-using that in all of these warn statements?
Comment on lines
+215
to
+217
| if (definitionVersion.specification === 'postman') { | ||
| switch (command) { | ||
| case 'openapi': |
There was a problem hiding this comment.
great job here with this if/switch logic — super readable and it's in the perfect spot 👏🏽
kanadgupta
added
documentation
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.
🧰 Changes
Describe in detail what this PR is for.
🧬 QA & Testing
Provide as much information as you can on how to test what you've done.