Skip to content

Update generated source code #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 27, 2021
Merged

Update generated source code #108

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98b2ae4
Update generated source code
cloudant-sdks-automation May 25, 2021
91f2227
Add 'disabling request body compression' section
emlaver May 25, 2021
5518b8c
Add new line
emlaver May 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions KNOWN_ISSUES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,24 @@ Example JSON request body:
}
```

### Monitoring, Authorization, and CORS

The server (Cloudant (Classic) <= 8169) incorrectly processes gzip compressed request bodies for the following endpoints:
| Endpoint | HTTP operation |
|---------------------------------------|----------------|
|`/_api/v2/user/activity_tracker/events`|`POST` |
|`/_api/v2/user/capacity/throughput` |`PUT` |
|`/_api/v2/api_keys` |`POST` |
|`/_api/v2/db/{db}/_security` |`PUT` |
|`/_api/v2/user/config/cors` |`PUT` |

The workaround is to [disable request body compression](#disabling-request-body-compression).

### Replication

The server (Cloudant (Classic) <= 8169) incorrectly processes gzip compressed request bodies for `_replicate` endpoint.
The workaround is to [disable request body compression](#disabling-request-body-compression).

### Cloudant on Transaction Engine

Whilst most SDK methods will work with _Cloudant on Transaction Engine_ there are some limitations.
Expand Down Expand Up @@ -131,3 +149,12 @@ The example above represents this JSON body:
...
}
```

### Disabling request body compression
Copy link
Contributor

@vmatyus vmatyus May 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A new line after the heading would make be aligned with other headings.


```python
from ibmcloudant.cloudant_v1 import CloudantV1
client = CloudantV1.new_instance(service_name="YOUR_SERVICE_NAME")
client.set_enable_gzip_compression(False)
...
```