Skip to content

Commit 0fee4cb

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 9aceca0 commit 0fee4cb

5 files changed

Lines changed: 22 additions & 22 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ project:
6666
- Handles the authentication.
6767
- Familiar user experience with IBM Cloud SDKs.
6868
- Flexibility to use either built-in models or byte-based requests and responses for documents.
69-
- Built-in [Changes feed follower](./docs/Changes_Follower.md)
70-
- Built-in [Pagination](./docs/Pagination.md) (beta)
69+
- Built-in [Changes feed follower](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Changes_Follower.md)
70+
- Built-in [Pagination](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Pagination.md) (beta)
7171
- Instances of the client are unconditionally thread-safe.
7272

7373
## Prerequisites
@@ -103,16 +103,16 @@ account.
103103

104104
There are several ways to **set** these authentication properties:
105105

106-
1. As [environment variables](./docs/Authentication.md#authentication-with-environment-variables)
107-
2. The [programmatic approach](./docs/Authentication.md#programmatic-authentication)
108-
3. With an [external credentials file](./docs/Authentication.md#authentication-with-external-configuration)
106+
1. As [environment variables](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Authentication.md#authentication-with-environment-variables)
107+
2. The [programmatic approach](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Authentication.md#programmatic-authentication)
108+
3. With an [external credentials file](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Authentication.md#authentication-with-external-configuration)
109109

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

113113
### Authentication
114114

115-
Consult the [authentication document](./docs/Authentication.md)
115+
Consult the [authentication document](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Authentication.md)
116116
for comprehensive details of all the available authentication methods and how to configure them with environment settings
117117
or programmatically.
118118

@@ -158,7 +158,7 @@ response = service.get_all_dbs().get_result()
158158
print(response)
159159
```
160160

161-
[More tutorial examples](./docs/Examples.md) for creating a database
161+
[More tutorial examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Examples.md) for creating a database
162162
and document create, read, update and delete operations.
163163

164164
For a complete list of code examples, see the [examples directory](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/examples#examples-for-python).
@@ -184,7 +184,7 @@ Response byte stream is supported in functions with the suffix of `_as_stream`.
184184
The returned byte stream allows the response body to be consumed
185185
without triggering JSON unmarshalling that is typically performed by the SDK.
186186

187-
The [update document](./docs/Examples.md#3-update-your-previously-created-document) section
187+
The [update document](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs/Examples.md#3-update-your-previously-created-document) section
188188
contains examples for both request and response byte stream cases.
189189

190190
The API reference contains further examples of using byte streams.
@@ -294,7 +294,7 @@ print(response)
294294

295295
### Further resources
296296

297-
- [Cloudant Python SDK feature docs](./docs)
297+
- [Cloudant Python SDK feature docs](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/docs)
298298
- [Cloudant API docs](https://cloud.ibm.com/apidocs/cloudant?code=python):
299299
API reference including usage examples for Cloudant Python SDK API.
300300
- [Pydoc](https://ibm.github.io/cloudant-python-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-python-sdk/tree/v0.10.5/examples#postchanges) instead of the follower.
70+
[POST `_changes` API](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/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-python-sdk/tree/v0.10.5/examples#postchanges)
104+
In these use-cases use the SDK's [POST `_changes` API](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/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
@@ -324,4 +324,4 @@ You have deleted the document.
324324

325325
## Further code examples
326326

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

docs/Pagination.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -71,22 +71,22 @@ then a `429 Too Many Requests` error occurs.
7171
Pagination is available for these operations:
7272
* Query all documents [global](https://cloud.ibm.com/apidocs/cloudant?code=python#postalldocs)
7373
and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=python#postpartitionalldocs)
74-
* [Global all documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/AllDocsPagination.py)
75-
* [Partitioned all documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/partition_all_docs_pagination.py)
74+
* [Global all documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/AllDocsPagination.py)
75+
* [Partitioned all documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/partition_all_docs_pagination.py)
7676
* Query all [design documents](https://cloud.ibm.com/apidocs/cloudant?code=python#postdesigndocs)
77-
* [Design documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/design_docs_pagination.py)
77+
* [Design documents examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/design_docs_pagination.py)
7878
* Query with selector syntax [global](https://cloud.ibm.com/apidocs/cloudant?code=python#postfind)
7979
and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=python#postpartitionfind)
80-
* [Global find selector query examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/find_pagination.py)
81-
* [Partitioned find selector query examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/partition_find_pagination.py)
80+
* [Global find selector query examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/find_pagination.py)
81+
* [Partitioned find selector query examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/partition_find_pagination.py)
8282
* Query a search index [global](https://cloud.ibm.com/apidocs/cloudant?code=python#postsearch)
8383
and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=python#postpartitionsearch)
84-
* [Global search examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/search_pagination.py)
85-
* [Partitioned search examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/partition_search_pagination.py)
84+
* [Global search examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/search_pagination.py)
85+
* [Partitioned search examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/partition_search_pagination.py)
8686
* Query a MapReduce view [global](https://cloud.ibm.com/apidocs/cloudant?code=python#postview)
8787
and [partitioned](https://cloud.ibm.com/apidocs/cloudant?code=python#postpartitionview)
88-
* [Global view examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/view_pagination.py)
89-
* [Partitioned view examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.5/test/examples/src/features/pagination/partition_view_pagination.py)
88+
* [Global view examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/view_pagination.py)
89+
* [Partitioned view examples](https://github.com/IBM/cloudant-python-sdk/tree/v0.10.6/test/examples/src/features/pagination/partition_view_pagination.py)
9090

9191
The examples presented in this `README` are for all documents in a partition.
9292
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 Python SDK Version 0.10.5 Detailed Documentation
1+
# IBM Cloudant Python SDK Version 0.10.6 Detailed Documentation
22

33
## Table of Contents
44

0 commit comments

Comments
 (0)