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

Commit e0d5098

Browse files
authored
[MIGRATION] Add note about authentication errors and server errors (#534)
1 parent 3a0a456 commit e0d5098

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

MIGRATION.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,19 @@ There are several ways to create a client connection in `cloudant-java-sdk`:
2323
1. There is no built-in pagination support for views. Examples coming soon.
2424
1. Replay interceptors are replaced by the [automatic retries](https://github.com/IBM/ibm-cloud-sdk-common/#automatic-retries) feature for failed requests.
2525
1. Error handling is not transferable from `java-cloudant` to `cloudant-java-sdk`. For more information go to the [Error handling section](https://cloud.ibm.com/apidocs/cloudant?code=java#error-handling) in our API docs.
26-
1. Custom HTTP client configurations in `java-cloudant` are not transferable to `cloudant-java-sdk`. For more information go to the [Configuring the HTTP client section(https://githubcom/IBM/ibm-cloud-sdk-common/#configuring-the-http-client) in the IBM Cloud SDK Common README.
26+
1. Custom HTTP client configurations in `java-cloudant` can be set differently in
27+
`cloudant-java-sdk`. For more information go to the
28+
[Configuring the HTTP client section](https://github.com/IBM/ibm-cloud-sdk-common/#configuring-the-http-client)
29+
in the IBM Cloud SDK Common README.
30+
31+
### Troubleshooting
32+
1. Authentication errors occur during service instantiation. For example, the code `Cloudant
33+
service = Cloudant.newInstance("EXAMPLE");` will fail with `Authentication information was
34+
not properly configured.` if required environment variables prefixed with `EXAMPLE` are not set.
35+
1. Server errors occur when running a request against the service. We suggest to
36+
check server errors with
37+
[`getServerInformation`](https://cloud.ibm.com/apidocs/cloudant?code=java#getserverinformation)
38+
which is the new alternative of `metaInformation()`.
2739

2840
### POJO usage in the new library
2941

0 commit comments

Comments
 (0)