Skip to content

Commit

Permalink
Format docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lyyder committed Aug 12, 2020
1 parent 2335000 commit ecf61ca
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/object-query-parameters.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Object query parameters

Some endpoints in the Flex Marketplace API require a specific syntax that allows passing one or more key-value pairs as the value of a single query parameter. The keys and values are colon-separated whereas the pairs are separated by semicolons. For example, when requesting custom image variants:
Some endpoints in the Flex Marketplace API require a specific syntax that allows
passing one or more key-value pairs as the value of a single query parameter.
The keys and values are colon-separated whereas the pairs are separated by
semicolons. For example, when requesting custom image variants:

``` js
sdk.listings.show({
Expand All @@ -13,7 +16,9 @@ sdk.listings.show({
});
```

To simplify building requests like these, the SDK provides a utility method: `sharetribeSdk.util.objectQueryString`. It serializes an object into the correct string syntax. Using this method, the request above can be written as follows:
To simplify building requests like these, the SDK provides a utility method:
`sharetribeSdk.util.objectQueryString`. It serializes an object into the correct
string syntax. Using this method, the request above can be written as follows:

``` js
sdk.listings.show({
Expand Down

0 comments on commit ecf61ca

Please sign in to comment.