This repository has been archived by the owner on Jul 14, 2022. It is now read-only.
Support API requests with nested query params #67
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
When performing a GET request for an individual asset
from the Shopify Admin API I noticed there isn't support for
nested query parameters.
For example performing this request:
GET /admin/themes/#{id}/assets.json?asset[key]=templates/index.liquid&theme_id=828155753
(https://help.shopify.com/api/reference/asset)
results in a query string seen by the server as follows:
{ theme_id: '11949473849',
asset: { key: 'assets/dci_locales.json' } }
However, the library querystring doesn't support nested objects and
therefore the final request URL sent to shopify isn't formed properly.
It works perfectly if I swap out the querystring library with the qs library.
See also nodejs/node-v0.x-archive#1665
marutypes
reviewed
Mar 19, 2018
| @@ -1,4 +1,4 @@ | |||
| const querystring = require('querystring'); | |||
| const qs = require('qs'); | |||
There was a problem hiding this comment.
A bit nicer to still call this querystring since it's much more readable than an acronym.
There was a problem hiding this comment.
Sure no problem. I will also start looking at creating a test for this.
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.
When performing a GET request for an individual asset
from the Shopify Admin API I noticed there isn't support for
nested query parameters.
For example performing this request:
GET /admin/themes/#{id}/assets.json?asset[key]=templates/index.liquid&theme_id=828155753
(https://help.shopify.com/api/reference/asset)
results in a query string seen by the server as follows:
{ theme_id: '11949473849',
asset: { key: 'assets/dci_locales.json' } }
However, the library querystring doesn't support nested objects and
therefore the final request URL sent to shopify isn't formed properly.
It works perfectly if I swap out the querystring library with the qs library.
See also nodejs/node-v0.x-archive#1665