Skip to content
This repository was archived by the owner on Oct 10, 2022. It is now read-only.

Commit 460dc21

Browse files
authored
Update README.md
1 parent 7a36cf1 commit 460dc21

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,10 @@ Every open-api method has the following signature:
7272

7373
#### `promise(response) = client.operationId([params], [opts])`
7474

75-
Perform a call to the given endpoint corresponding with the `operationId`. Returns promise that will resolve with the body of the response, or reject with an error with details about the request attached. Rejects if the `status` > 400. Successful response objects have `status` and `statusText` properties on their prototype.
75+
Perform a call to the given endpoint corresponding with the `operationId`. Returns promise that will resolve with the body of the response, or reject with an error with details about the request attached. Rejects if the `status` > 400.
7676

7777
- `params` is an object that includes any of the required or optional endpoint parameters.
78-
- `params.body` should be an object which gets serialized to JSON automatically.
78+
- `params.body` should be an object which gets serialized to JSON automatically. Any object can live here but refer to the open-api specification for allowed fields in a particular request body.
7979
- If the endpoint accepts `binary`, `params.body` can be a Node.js readable stream or stream ctor (e.g. `() => fs.createReadStream('./foo')`). A Stream ctor function is required to support rate limit retry.
8080

8181
```js

0 commit comments

Comments
 (0)