Skip to content

Commit 9747c10

Browse files
cloudant-sdks-automationricellis
authored andcommitted
docs(generated): link to current release tag docs folder
Generated SDK source code using: - Generator version 3.107.1 - Specification version 1.0.0-dev0.1.29 - Automation (cloudant-sdks) version ba36195
1 parent 8f79eb6 commit 9747c10

File tree

5 files changed

+22
-22
lines changed

5 files changed

+22
-22
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ project:
6767
- Handles the authentication.
6868
- Familiar user experience with IBM Cloud SDKs.
6969
- Flexibility to use either built-in models or byte-based requests and responses for documents.
70-
- Built-in [Changes feed follower](./docs/Changes_Follower.md)
71-
- Built-in [Pagination](./docs/Pagination.md) (beta)
70+
- Built-in [Changes feed follower](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Changes_Follower.md)
71+
- Built-in [Pagination](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Pagination.md) (beta)
7272
- HTTP2 support for higher performance connections to IBM Cloudant.
7373
- Perform requests either synchronously or asynchronously.
7474
- Instances of the client are unconditionally thread-safe.
@@ -138,16 +138,16 @@ account.
138138

139139
There are several ways to **set** these authentication properties:
140140

141-
1. As [environment variables](./docs/Authentication.md#authentication-with-environment-variables)
142-
2. The [programmatic approach](./docs/Authentication.md#programmatic-authentication)
143-
3. With an [external credentials file](./docs/Authentication.md#authentication-with-external-configuration)
141+
1. As [environment variables](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Authentication.md#authentication-with-environment-variables)
142+
2. The [programmatic approach](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Authentication.md#programmatic-authentication)
143+
3. With an [external credentials file](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Authentication.md#authentication-with-external-configuration)
144144

145145
The following section describes the different authentication types and provides environment variable examples.
146146
Examples for other configuration methods are available by following the provided links.
147147

148148
### Authentication
149149

150-
Consult the [authentication document](./docs/Authentication.md)
150+
Consult the [authentication document](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Authentication.md)
151151
for comprehensive details of all the available authentication methods and how to configure them with environment settings
152152
or programmatically.
153153

@@ -196,7 +196,7 @@ List<String> response =
196196
System.out.println(response);
197197
```
198198

199-
[More tutorial examples](./docs/Examples.md) for creating a database
199+
[More tutorial examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Examples.md) for creating a database
200200
and document create, read, update and delete operations.
201201

202202
For a complete list of code examples, see the [examples directory](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/examples#examples-for-java).
@@ -222,7 +222,7 @@ Response byte stream is supported in functions with the suffix of `AsStream`.
222222
The returned byte stream allows the response body to be consumed
223223
without triggering JSON unmarshalling that is typically performed by the SDK.
224224

225-
The [update document](./docs/Examples.md#3-update-your-previously-created-document) section
225+
The [update document](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Examples.md#3-update-your-previously-created-document) section
226226
contains examples for both request and response byte stream cases.
227227

228228
The API reference contains further examples of using byte streams.
@@ -238,7 +238,7 @@ Expand them to see examples of:
238238

239239
### Further resources
240240

241-
- [Cloudant Java SDK feature docs](./docs)
241+
- [Cloudant Java SDK feature docs](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs)
242242
- [Cloudant API docs](https://cloud.ibm.com/apidocs/cloudant?code=java):
243243
API reference including usage examples for Cloudant Java SDK API.
244244
- [Javadoc](https://ibm.github.io/cloudant-java-sdk/):

docs/Changes_Follower.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The changes follower requires the client to have HTTP timeouts of at least 1 min
6767
instantiation if it is insufficient. The default client configuration has sufficiently long timeouts.
6868

6969
For use-cases where these configuration limitations are too restrictive then write code to use the SDK's
70-
[POST `_changes` API](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/examples#postchanges) instead of the follower.
70+
[POST `_changes` API](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/examples#postchanges) instead of the follower.
7171

7272
## Error suppression
7373

@@ -101,7 +101,7 @@ The follower is not optimized for some use cases and it is not recommended to us
101101
* Setting `include_docs` and larger document sizes (for example > 10 kiB).
102102
* The volume of changes is very high (if the rate of changes in the database exceeds the follower's rate of pulling them it can never catch-up).
103103

104-
In these use-cases use the SDK's [POST `_changes` API](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/examples#postchanges)
104+
In these use-cases use the SDK's [POST `_changes` API](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/examples#postchanges)
105105
for specific control over the number of change requests made and the content size of the responses.
106106

107107
## Checkpoints

docs/Examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -421,4 +421,4 @@ You have deleted the document.
421421

422422
## Further code examples
423423

424-
For a complete list of code examples, see the [examples directory](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/examples#examples-for-java).
424+
For a complete list of code examples, see the [examples directory](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/examples#examples-for-java).

docs/Pagination.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -73,22 +73,22 @@ then a `429 Too Many Requests` error occurs.
7373
Pagination is available for these operations:
7474
* Query all documents [global](https://cloud.ibm.com/apidocs/cloudant?code=java#postalldocs)
7575
and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=java#postpartitionalldocs)
76-
* [Global all documents examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/AllDocsPagination.java)
77-
* [Partitioned all documents examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/PartitionAllDocsPagination.java)
76+
* [Global all documents examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/AllDocsPagination.java)
77+
* [Partitioned all documents examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/PartitionAllDocsPagination.java)
7878
* Query all [design documents](https://cloud.ibm.com/apidocs/cloudant?code=java#postdesigndocs)
79-
* [Design documents examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/DesignDocsPagination.java)
79+
* [Design documents examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/DesignDocsPagination.java)
8080
* Query with selector syntax [global](https://cloud.ibm.com/apidocs/cloudant?code=java#postfind)
8181
and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=java#postpartitionfind)
82-
* [Global find selector query examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/FindPagination.java)
83-
* [Partitioned find selector query examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/PartitionFindPagination.java)
82+
* [Global find selector query examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/FindPagination.java)
83+
* [Partitioned find selector query examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/PartitionFindPagination.java)
8484
* Query a search index [global](https://cloud.ibm.com/apidocs/cloudant?code=java#postsearch)
8585
and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=java#postpartitionsearch)
86-
* [Global search examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/SearchPagination.java)
87-
* [Partitioned search examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/PartitionSearchPagination.java)
86+
* [Global search examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/SearchPagination.java)
87+
* [Partitioned search examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/PartitionSearchPagination.java)
8888
* Query a MapReduce view [global](https://cloud.ibm.com/apidocs/cloudant?code=java#postview)
8989
and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=java#postpartitionview)
90-
* [Global view examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/ViewPagination.java)
91-
* [Partitioned view examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/PartitionViewPagination.java)
90+
* [Global view examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/ViewPagination.java)
91+
* [Partitioned view examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/PartitionViewPagination.java)
9292

9393
The examples presented in this `README` are for all documents in a partition.
9494
The links in the list are to equivalent examples for each of the other available operations.

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# IBM Cloudant Java SDK Version 0.10.6 Detailed Documentation
1+
# IBM Cloudant Java SDK Version 0.10.7 Detailed Documentation
22

33
## Table of Contents
44

0 commit comments

Comments
 (0)