Skip to content

Commit

Permalink
docs(generated): add ddoc filter known issue
Browse files Browse the repository at this point in the history
Generated SDK source code using:
- Generator version 3.79.0
- Specification version 1.0.0-dev0.1.5
- Automation (cloudant-sdks) version 7a2df44

Signed-off-by: cloudant-sdks-automation <[email protected]>
  • Loading branch information
cloudant-sdks-automation authored and emlaver committed Oct 20, 2023
1 parent db7cbda commit 3027cd5
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions KNOWN_ISSUES.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,33 @@ Example JSON request body:
* Manually setting an `Accept-Encoding` header on requests will disable the transparent gzip decompression of response bodies from the server.
* Manually setting a `Content-Encoding` header on requests will disable the transparent gzip compression of request bodies to the server.

### Changes feed

#### Filter functions

The SDK does not support passing user-defined query or body parameters in `_changes` requests for dynamic filter functions in design documents.
The workaround and recommended option is to use a `selector` type filter.
For example, if you are using a `_changes` request like `/{db}/_changes?filter=myDdoc/byName&name=Jane` with a filter function like:
```javascript
function(doc, req) {
if (doc.name !== req.query.name) {
return false;
}
return true;
}
```
It can be replaced with a request using a selector filter:
```js
const service = CloudantV1.newInstance({});

service.postChanges({
db: 'example',
filter: '_selector',
selector: {"name": "Jane"}
}).then(response => { ... });
```


## Cloudant SDK for Node.js
<!-- KNOWN_ISSUES specific to Node -->
### Disabling request body compression
Expand Down

0 comments on commit 3027cd5

Please sign in to comment.