From 870053cb184c36462e57441c6ea05d058052eeef Mon Sep 17 00:00:00 2001 From: cloudant-sdks-automation <71659186+cloudant-sdks-automation@users.noreply.github.com> Date: Thu, 28 Aug 2025 13:48:02 +0000 Subject: [PATCH] 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 --- README.md | 18 +++++++++--------- docs/Changes_Follower.md | 4 ++-- docs/Examples.md | 2 +- docs/Pagination.md | 18 +++++++++--------- docs/README.md | 2 +- 5 files changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 236cb5770..4d2371be5 100644 --- a/README.md +++ b/README.md @@ -67,8 +67,8 @@ project: - Handles the authentication. - Familiar user experience with IBM Cloud SDKs. - Flexibility to use either built-in models or byte-based requests and responses for documents. -- Built-in [Changes feed follower](./docs/Changes_Follower.md) -- Built-in [Pagination](./docs/Pagination.md) (beta) +- Built-in [Changes feed follower](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Changes_Follower.md) +- Built-in [Pagination](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Pagination.md) (beta) - HTTP2 support for higher performance connections to IBM Cloudant. - Perform requests either synchronously or asynchronously. - Instances of the client are unconditionally thread-safe. @@ -138,16 +138,16 @@ account. There are several ways to **set** these authentication properties: -1. As [environment variables](./docs/Authentication.md#authentication-with-environment-variables) -2. The [programmatic approach](./docs/Authentication.md#programmatic-authentication) -3. With an [external credentials file](./docs/Authentication.md#authentication-with-external-configuration) +1. As [environment variables](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Authentication.md#authentication-with-environment-variables) +2. The [programmatic approach](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Authentication.md#programmatic-authentication) +3. With an [external credentials file](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Authentication.md#authentication-with-external-configuration) The following section describes the different authentication types and provides environment variable examples. Examples for other configuration methods are available by following the provided links. ### Authentication -Consult the [authentication document](./docs/Authentication.md) +Consult the [authentication document](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Authentication.md) for comprehensive details of all the available authentication methods and how to configure them with environment settings or programmatically. @@ -196,7 +196,7 @@ List response = System.out.println(response); ``` -[More tutorial examples](./docs/Examples.md) for creating a database +[More tutorial examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Examples.md) for creating a database and document create, read, update and delete operations. 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`. The returned byte stream allows the response body to be consumed without triggering JSON unmarshalling that is typically performed by the SDK. -The [update document](./docs/Examples.md#3-update-your-previously-created-document) section +The [update document](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs/Examples.md#3-update-your-previously-created-document) section contains examples for both request and response byte stream cases. The API reference contains further examples of using byte streams. @@ -238,7 +238,7 @@ Expand them to see examples of: ### Further resources -- [Cloudant Java SDK feature docs](./docs) +- [Cloudant Java SDK feature docs](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/docs) - [Cloudant API docs](https://cloud.ibm.com/apidocs/cloudant?code=java): API reference including usage examples for Cloudant Java SDK API. - [Javadoc](https://ibm.github.io/cloudant-java-sdk/): diff --git a/docs/Changes_Follower.md b/docs/Changes_Follower.md index 6eaa0dacb..f3be76acf 100644 --- a/docs/Changes_Follower.md +++ b/docs/Changes_Follower.md @@ -67,7 +67,7 @@ The changes follower requires the client to have HTTP timeouts of at least 1 min instantiation if it is insufficient. The default client configuration has sufficiently long timeouts. For use-cases where these configuration limitations are too restrictive then write code to use the SDK's -[POST `_changes` API](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/examples#postchanges) instead of the follower. +[POST `_changes` API](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/examples#postchanges) instead of the follower. ## Error suppression @@ -101,7 +101,7 @@ The follower is not optimized for some use cases and it is not recommended to us * Setting `include_docs` and larger document sizes (for example > 10 kiB). * 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). -In these use-cases use the SDK's [POST `_changes` API](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/examples#postchanges) +In these use-cases use the SDK's [POST `_changes` API](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/examples#postchanges) for specific control over the number of change requests made and the content size of the responses. ## Checkpoints diff --git a/docs/Examples.md b/docs/Examples.md index a750bf370..530d9bd08 100644 --- a/docs/Examples.md +++ b/docs/Examples.md @@ -421,4 +421,4 @@ You have deleted the document. ## Further code examples -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). +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). diff --git a/docs/Pagination.md b/docs/Pagination.md index 7f2d800fe..f80ea6a49 100644 --- a/docs/Pagination.md +++ b/docs/Pagination.md @@ -73,22 +73,22 @@ then a `429 Too Many Requests` error occurs. Pagination is available for these operations: * Query all documents [global](https://cloud.ibm.com/apidocs/cloudant?code=java#postalldocs) and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=java#postpartitionalldocs) - * [Global all documents examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/AllDocsPagination.java) - * [Partitioned all documents examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/PartitionAllDocsPagination.java) + * [Global all documents examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/AllDocsPagination.java) + * [Partitioned all documents examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/PartitionAllDocsPagination.java) * Query all [design documents](https://cloud.ibm.com/apidocs/cloudant?code=java#postdesigndocs) - * [Design documents examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/DesignDocsPagination.java) + * [Design documents examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/DesignDocsPagination.java) * Query with selector syntax [global](https://cloud.ibm.com/apidocs/cloudant?code=java#postfind) and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=java#postpartitionfind) - * [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) - * [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) + * [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) + * [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) * Query a search index [global](https://cloud.ibm.com/apidocs/cloudant?code=java#postsearch) and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=java#postpartitionsearch) - * [Global search examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/SearchPagination.java) - * [Partitioned search examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/PartitionSearchPagination.java) + * [Global search examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/SearchPagination.java) + * [Partitioned search examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/PartitionSearchPagination.java) * Query a MapReduce view [global](https://cloud.ibm.com/apidocs/cloudant?code=java#postview) and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=java#postpartitionview) - * [Global view examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/ViewPagination.java) - * [Partitioned view examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.6/modules/examples/src/main/java/features/pagination/PartitionViewPagination.java) + * [Global view examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/ViewPagination.java) + * [Partitioned view examples](https://github.com/IBM/cloudant-java-sdk/tree/v0.10.7/modules/examples/src/main/java/features/pagination/PartitionViewPagination.java) The examples presented in this `README` are for all documents in a partition. The links in the list are to equivalent examples for each of the other available operations. diff --git a/docs/README.md b/docs/README.md index 2d1109f6a..740e60b9c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# IBM Cloudant Java SDK Version 0.10.6 Detailed Documentation +# IBM Cloudant Java SDK Version 0.10.7 Detailed Documentation ## Table of Contents