From ea2c7a2005fa52ab3a46d244b1e6e6c6c4f896e1 Mon Sep 17 00:00:00 2001 From: cloudant-sdks-automation <71659186+cloudant-sdks-automation@users.noreply.github.com> Date: Thu, 2 Oct 2025 17:48:46 +0000 Subject: [PATCH 1/2] docs(generated): replace placeholder values in examples Generated SDK source code using: - Generator version 3.107.1 - Specification version 1.0.0-dev0.1.29 - Automation (cloudant-sdks) version 14e653f --- README.md | 4 +-- docs/Authentication.md | 20 ++++++------ examples/README.md | 32 +++++++++---------- .../deleteAttachment/example_request.py | 2 +- .../deleteDatabase/example_request.py | 2 +- .../deleteDesignDocument/example_request.py | 2 +- .../deleteDocument/example_request.py | 2 +- .../example_request.py | 2 +- .../example_request_delete_documents.py | 4 +-- ...ernative_example_request_for_atts_since.py | 2 +- .../snippets/postBulkGet/example_request.py | 4 +-- .../snippets/postRevsDiff/example_request.py | 6 ++-- .../putReplicationDocument/example_request.py | 6 ++-- 13 files changed, 44 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 5f1fd6c5..1ddff212 100644 --- a/README.md +++ b/README.md @@ -118,14 +118,14 @@ or programmatically. Quick start for Cloudant with an IAM API key: ```sh -CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL # use your own Cloudant public or private URL +CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL CLOUDANT_APIKEY=a1b2c3d4e5f6f1g4h7j3k6l9m2p5q8s1t4v7x0z3 # use your own IAM API key ``` Quick start for Apache CouchDB with a username/password session: ```sh CLOUDANT_AUTH_TYPE=COUCHDB_SESSION -CLOUDANT_URL=http://~replaceWithYourUniqueHost~.example:5984 # use your CouchDB URL +CLOUDANT_URL=https://~replace-with-your-unique-host~.example:6984 # use your CouchDB URL CLOUDANT_USERNAME=username # replace with your username CLOUDANT_PASSWORD=password # replace with your password ``` diff --git a/docs/Authentication.md b/docs/Authentication.md index a7295781..9709a6ce 100644 --- a/docs/Authentication.md +++ b/docs/Authentication.md @@ -58,7 +58,7 @@ amending the values with your own `CLOUDANT_AUTH_TYPE` to `IAM` because it is the default when supplying an `APIKEY`. ```sh -CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL +CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL CLOUDANT_APIKEY=a1b2c3d4e5f6f1g4h7j3k6l9m2p5q8s1t4v7x0z3 # use your own IAM API key ``` @@ -69,8 +69,8 @@ amending with your own correct values. There is no need to set `CLOUDANT_AUTH_TYPE` to `CONTAINER` because it is the default. ```sh -CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL -CLOUDANT_IAM_PROFILE_ID=iam-Profile-00000000-aaaa-4444-bbbb-0123456789ab # use your own IAM profile ID +CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL +CLOUDANT_IAM_PROFILE_ID=iam-Profile-00000000-0000-0000-0000-000000000000 # use your own IAM profile ID ``` Alternatives to `CLOUDANT_IAM_PROFILE_ID`: @@ -83,8 +83,8 @@ amending with your own correct values. ```sh CLOUDANT_AUTH_TYPE=VPC -CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL -CLOUDANT_IAM_PROFILE_ID=iam-Profile-00000000-aaaa-4444-bbbb-0123456789ab # use your own IAM profile ID +CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL +CLOUDANT_IAM_PROFILE_ID=iam-Profile-00000000-0000-0000-0000-000000000000 # use your own IAM profile ID ``` Alternatives to `CLOUDANT_IAM_PROFILE_ID`: @@ -98,8 +98,8 @@ amending with your own correct values. ```sh CLOUDANT_AUTH_TYPE=IAMASSUME -CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL -CLOUDANT_IAM_PROFILE_ID=iam-Profile-00000000-aaaa-4444-bbbb-0123456789ab # use your own IAM profile ID +CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL +CLOUDANT_IAM_PROFILE_ID=iam-Profile-00000000-0000-0000-0000-000000000000 # use your own IAM profile ID ``` Alternatives to `CLOUDANT_IAM_PROFILE_ID`: @@ -113,7 +113,7 @@ amending with your own [service credentials](https://cloud.ibm.com/docs/Cloudant ```sh CLOUDANT_AUTH_TYPE=COUCHDB_SESSION -CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL +CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL CLOUDANT_USERNAME=username # replace with your Cloudant legacy username CLOUDANT_PASSWORD=password # replace with your Cloudant legacy password or API key (not IAM) ``` @@ -127,7 +127,7 @@ amending with your own correct values. ```sh CLOUDANT_AUTH_TYPE=BEARERTOKEN -CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL +CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL CLOUDANT_BEARER_TOKEN=A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c # replace with your bearer token ``` @@ -140,7 +140,7 @@ amending with your own correct values. ```sh CLOUDANT_AUTH_TYPE=BASIC -CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL +CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL CLOUDANT_USERNAME=username # replace with your Cloudant legacy username CLOUDANT_PASSWORD=password # replace with your Cloudant legacy password or API key (not IAM) ``` diff --git a/examples/README.md b/examples/README.md index 9673e113..dd2db2cf 100644 --- a/examples/README.md +++ b/examples/README.md @@ -308,7 +308,7 @@ service = CloudantV1.new_instance() response = service.delete_replication_document( doc_id='repldoc-example', -rev='3-a0ccbdc6fe95b4184f9031d086034d85' +rev='1-00000000000000000000000000000000' ).get_result() print(response) @@ -368,18 +368,18 @@ from ibmcloudant.cloudant_v1 import CloudantV1, ReplicationDocument, Replication service = CloudantV1.new_instance() source_db = ReplicationDatabase( - url='/animaldb' + url='https://~replace-with-source-host~.cloudantnosqldb.appdomain.cloud/animaldb' ) target_auth_iam = ReplicationDatabaseAuthIam( - api_key='' + api_key='a1b2c3d4e5f6f1g4h7j3k6l9m2p5q8s1t4v7x0z3' #use your own IAM API key ) target_auth = ReplicationDatabaseAuth( iam=target_auth_iam ) target_db = ReplicationDatabase( auth=target_auth, - url='/animaldb-target' + url='https://~replace-with-target-host~.cloudantnosqldb.appdomain.cloud/animaldb-target' ) replication_document = ReplicationDocument( @@ -586,7 +586,7 @@ from ibmcloudant.cloudant_v1 import CloudantV1 service = CloudantV1.new_instance() -response = service.delete_database(db='').get_result() +response = service.delete_database(db='products').get_result() print(response) ``` @@ -797,12 +797,12 @@ service = CloudantV1.new_instance() event_doc_1 = Document( _id="ns1HJS13AMkK:0007241142412418284", - _rev="1-5005d65514fe9e90f8eccf174af5dd64", + _rev="1-00000000000000000000000000000000", _deleted=True, ) event_doc_2 = Document( _id="H8tDIwfadxp9:0007241142412418285", - _rev="1-2d7810b054babeda4812b3924428d6d6", + _rev="1-00000000000000000000000000000000", _deleted=True, ) @@ -873,10 +873,10 @@ service = CloudantV1.new_instance() doc_id = 'order00067' bulk_get_doc_1 = BulkGetQueryDocument( id=doc_id, - rev='3-917fa2381192822767f010b95b45325b') + rev='3-22222222222222222222222222222222') bulk_get_doc_2 = BulkGetQueryDocument( id=doc_id, - rev='4-a5be949eeb7296747cc271766e9a498b') + rev='4-33333333333333333333333333333333') response = service.post_bulk_get( db='orders', @@ -915,7 +915,7 @@ service = CloudantV1.new_instance() bulk_get_doc = BulkGetQueryDocument( id='order00058', - atts_since=['1-99b02e08da151943c2dcb40090160bb8']) + atts_since=['1-00000000000000000000000000000000']) response = service.post_bulk_get( db='orders', docs=[bulk_get_doc] @@ -977,7 +977,7 @@ service = CloudantV1.new_instance() response = service.delete_design_document( db='products', ddoc='appliances', - rev='1-98e6a25b3b45df62e7d47095ac15b16a' + rev='1-00000000000000000000000000000000' ).get_result() print(response) @@ -1681,9 +1681,9 @@ service = CloudantV1.new_instance() revs_diff = DocumentRevisions( order00077=[ - "<1-missing-revision>", - "<2-missing-revision>", - "<3-possible-ancestor-revision>" + "1-00000000000000000000000000000000", # missing revision + "2-11111111111111111111111111111111", # missing revision + "3-22222222222222222222222222222222" # possible ancestor revision ] ) @@ -1804,7 +1804,7 @@ service = CloudantV1.new_instance() response = service.delete_document( db='orders', doc_id='order00058', - rev='1-99b02e08da151943c2dcb40090160bb8' + rev='1-00000000000000000000000000000000' ).get_result() print(response) @@ -1898,7 +1898,7 @@ response = service.delete_attachment( db='products', doc_id='1000042', attachment_name='product_details.txt', - rev='4-1a0d1cd6f40472509e9aac646183736a' + rev='4-33333333333333333333333333333333' ).get_result() print(response) diff --git a/examples/snippets/deleteAttachment/example_request.py b/examples/snippets/deleteAttachment/example_request.py index dc2c3a2c..1d4edd2b 100644 --- a/examples/snippets/deleteAttachment/example_request.py +++ b/examples/snippets/deleteAttachment/example_request.py @@ -7,7 +7,7 @@ db='products', doc_id='1000042', attachment_name='product_details.txt', - rev='4-1a0d1cd6f40472509e9aac646183736a' + rev='4-33333333333333333333333333333333' ).get_result() print(response) diff --git a/examples/snippets/deleteDatabase/example_request.py b/examples/snippets/deleteDatabase/example_request.py index 0ca7bc37..77f7c021 100644 --- a/examples/snippets/deleteDatabase/example_request.py +++ b/examples/snippets/deleteDatabase/example_request.py @@ -3,6 +3,6 @@ service = CloudantV1.new_instance() -response = service.delete_database(db='').get_result() +response = service.delete_database(db='products').get_result() print(response) diff --git a/examples/snippets/deleteDesignDocument/example_request.py b/examples/snippets/deleteDesignDocument/example_request.py index bc175eb4..af0aa41f 100644 --- a/examples/snippets/deleteDesignDocument/example_request.py +++ b/examples/snippets/deleteDesignDocument/example_request.py @@ -6,7 +6,7 @@ response = service.delete_design_document( db='products', ddoc='appliances', - rev='1-98e6a25b3b45df62e7d47095ac15b16a' + rev='1-00000000000000000000000000000000' ).get_result() print(response) diff --git a/examples/snippets/deleteDocument/example_request.py b/examples/snippets/deleteDocument/example_request.py index ee64b47a..e3ccea00 100644 --- a/examples/snippets/deleteDocument/example_request.py +++ b/examples/snippets/deleteDocument/example_request.py @@ -6,7 +6,7 @@ response = service.delete_document( db='orders', doc_id='order00058', - rev='1-99b02e08da151943c2dcb40090160bb8' + rev='1-00000000000000000000000000000000' ).get_result() print(response) diff --git a/examples/snippets/deleteReplicationDocument/example_request.py b/examples/snippets/deleteReplicationDocument/example_request.py index 9e2d91ff..a3325376 100644 --- a/examples/snippets/deleteReplicationDocument/example_request.py +++ b/examples/snippets/deleteReplicationDocument/example_request.py @@ -5,7 +5,7 @@ response = service.delete_replication_document( doc_id='repldoc-example', -rev='3-a0ccbdc6fe95b4184f9031d086034d85' +rev='1-00000000000000000000000000000000' ).get_result() print(response) diff --git a/examples/snippets/postBulkDocs/example_request_delete_documents.py b/examples/snippets/postBulkDocs/example_request_delete_documents.py index c70a8e80..09ffeece 100644 --- a/examples/snippets/postBulkDocs/example_request_delete_documents.py +++ b/examples/snippets/postBulkDocs/example_request_delete_documents.py @@ -5,12 +5,12 @@ event_doc_1 = Document( _id="ns1HJS13AMkK:0007241142412418284", - _rev="1-5005d65514fe9e90f8eccf174af5dd64", + _rev="1-00000000000000000000000000000000", _deleted=True, ) event_doc_2 = Document( _id="H8tDIwfadxp9:0007241142412418285", - _rev="1-2d7810b054babeda4812b3924428d6d6", + _rev="1-00000000000000000000000000000000", _deleted=True, ) diff --git a/examples/snippets/postBulkGet/alternative_example_request_for_atts_since.py b/examples/snippets/postBulkGet/alternative_example_request_for_atts_since.py index b9d77083..0811db87 100644 --- a/examples/snippets/postBulkGet/alternative_example_request_for_atts_since.py +++ b/examples/snippets/postBulkGet/alternative_example_request_for_atts_since.py @@ -5,7 +5,7 @@ bulk_get_doc = BulkGetQueryDocument( id='order00058', - atts_since=['1-99b02e08da151943c2dcb40090160bb8']) + atts_since=['1-00000000000000000000000000000000']) response = service.post_bulk_get( db='orders', docs=[bulk_get_doc] diff --git a/examples/snippets/postBulkGet/example_request.py b/examples/snippets/postBulkGet/example_request.py index e161518a..ad88c649 100644 --- a/examples/snippets/postBulkGet/example_request.py +++ b/examples/snippets/postBulkGet/example_request.py @@ -6,10 +6,10 @@ doc_id = 'order00067' bulk_get_doc_1 = BulkGetQueryDocument( id=doc_id, - rev='3-917fa2381192822767f010b95b45325b') + rev='3-22222222222222222222222222222222') bulk_get_doc_2 = BulkGetQueryDocument( id=doc_id, - rev='4-a5be949eeb7296747cc271766e9a498b') + rev='4-33333333333333333333333333333333') response = service.post_bulk_get( db='orders', diff --git a/examples/snippets/postRevsDiff/example_request.py b/examples/snippets/postRevsDiff/example_request.py index 970c1a96..5dd6092f 100644 --- a/examples/snippets/postRevsDiff/example_request.py +++ b/examples/snippets/postRevsDiff/example_request.py @@ -5,9 +5,9 @@ revs_diff = DocumentRevisions( order00077=[ - "<1-missing-revision>", - "<2-missing-revision>", - "<3-possible-ancestor-revision>" + "1-00000000000000000000000000000000", # missing revision + "2-11111111111111111111111111111111", # missing revision + "3-22222222222222222222222222222222" # possible ancestor revision ] ) diff --git a/examples/snippets/putReplicationDocument/example_request.py b/examples/snippets/putReplicationDocument/example_request.py index 0083d909..0c2d92dc 100644 --- a/examples/snippets/putReplicationDocument/example_request.py +++ b/examples/snippets/putReplicationDocument/example_request.py @@ -4,18 +4,18 @@ service = CloudantV1.new_instance() source_db = ReplicationDatabase( - url='/animaldb' + url='https://~replace-with-source-host~.cloudantnosqldb.appdomain.cloud/animaldb' ) target_auth_iam = ReplicationDatabaseAuthIam( - api_key='' + api_key='a1b2c3d4e5f6f1g4h7j3k6l9m2p5q8s1t4v7x0z3' #use your own IAM API key ) target_auth = ReplicationDatabaseAuth( iam=target_auth_iam ) target_db = ReplicationDatabase( auth=target_auth, - url='/animaldb-target' + url='https://~replace-with-target-host~.cloudantnosqldb.appdomain.cloud/animaldb-target' ) replication_document = ReplicationDocument( From 5a1fb0ade6a6a4f85b45910ccba1d61d1114c16d Mon Sep 17 00:00:00 2001 From: Rich Ellis Date: Fri, 3 Oct 2025 10:47:38 +0100 Subject: [PATCH 2/2] chore: update secrets baseline --- .secrets.baseline | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/.secrets.baseline b/.secrets.baseline index 1ec428be..e75f570f 100644 --- a/.secrets.baseline +++ b/.secrets.baseline @@ -3,7 +3,7 @@ "files": "^.secrets.baseline$", "lines": "(?i)^\\s*\"(?:transaction|x-couch-request|x-request)-id\": \"[^\"]+\",?$|^\\s*\"(?:last_|update_|purge_|checkpointed_source_|source_|through_)?seq\": \"[^\"]+\",?$|^\\s*\"(?:doc_)?id\": \"[^\"]+\",?$|^\\s*\"(?:signature|name|uuid)\": \"[^\"]+\",?$" }, - "generated_at": "2025-08-15T10:14:15Z", + "generated_at": "2025-10-03T09:46:18Z", "plugins_used": [ { "name": "AWSKeyDetector" @@ -82,7 +82,7 @@ "hashed_secret": "bb589d0621e5472f470fa3425a234c74b1e202e8", "is_secret": false, "is_verified": false, - "line_number": 325, + "line_number": 341, "type": "Secret Keyword", "verified_result": null } @@ -109,7 +109,15 @@ ], "examples/README.md": [ { - "hashed_secret": "701e4e52db78a3657f5bc71fd174cf29e7868fbd", + "hashed_secret": "7740cecbbf3c508248997e0b3b1c24cc00a2759a", + "is_secret": false, + "is_verified": false, + "line_number": 375, + "type": "Base64 High Entropy String", + "verified_result": null + }, + { + "hashed_secret": "7740cecbbf3c508248997e0b3b1c24cc00a2759a", "is_secret": false, "is_verified": false, "line_number": 375, @@ -135,7 +143,15 @@ ], "examples/snippets/putReplicationDocument/example_request.py": [ { - "hashed_secret": "701e4e52db78a3657f5bc71fd174cf29e7868fbd", + "hashed_secret": "7740cecbbf3c508248997e0b3b1c24cc00a2759a", + "is_secret": false, + "is_verified": false, + "line_number": 11, + "type": "Base64 High Entropy String", + "verified_result": null + }, + { + "hashed_secret": "7740cecbbf3c508248997e0b3b1c24cc00a2759a", "is_secret": false, "is_verified": false, "line_number": 11, @@ -216,7 +232,7 @@ } ] }, - "version": "0.13.1+ibm.62.dss", + "version": "0.13.1+ibm.64.dss", "word_list": { "file": null, "hash": null