This repository has been archived by the owner on Nov 28, 2022. It is now read-only.
chore(oas-to-snippet): replace stringified request body with JSON.stringify and object #1056
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
…ingify and object
erunion
reviewed
Nov 19, 2020
packages/oas-to-snippet/src/index.js
Outdated
| @@ -44,6 +44,12 @@ module.exports = (oas, operation, values, auth, lang, oasUrl) => { | |||
| }; | |||
| } | |||
|
|
|||
| if (lang === 'node') { | |||
| language.httpsnippet[2] = { | |||
| useObjectBody: true, | |||
There was a problem hiding this comment.
You want to move this into src/supportedLanguages instead? Since it's not using oasUrl or oas like node-simple snippets are we can probably leave this option contained there.
There was a problem hiding this comment.
Oh totally, way better. Didn't notice that config list before. Getting a new pr shortly.
erunion
approved these changes
Nov 19, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
replace stringified request body with JSON.stringify and object
🧰 What's being changed?
The request body in the node example must be a string. Originally we were translating the JSON object to a string and including that. A JSON.stringified object is difficult to read, so this PR keeps the object literal and wraps it in a JSON.stringify call in the example.
See https://app.asana.com/0/1199087650851461/1198986894847661 for more discussion and example pictures.
🧪 Testing
Go to the petstore example, and the "add a new pet" API call. Start typing in the "category" request body form below the example, and you should see the example automatically update with a request body that is an object literal wrapped in JSON.stringify.