Skip to content

Commit ea2c7a2

Browse files
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
1 parent 9f619cb commit ea2c7a2

13 files changed

Lines changed: 44 additions & 44 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,14 +118,14 @@ or programmatically.
118118

119119
Quick start for Cloudant with an IAM API key:
120120
```sh
121-
CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL # use your own Cloudant public or private URL
121+
CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL
122122
CLOUDANT_APIKEY=a1b2c3d4e5f6f1g4h7j3k6l9m2p5q8s1t4v7x0z3 # use your own IAM API key
123123
```
124124

125125
Quick start for Apache CouchDB with a username/password session:
126126
```sh
127127
CLOUDANT_AUTH_TYPE=COUCHDB_SESSION
128-
CLOUDANT_URL=http://~replaceWithYourUniqueHost~.example:5984 # use your CouchDB URL
128+
CLOUDANT_URL=https://~replace-with-your-unique-host~.example:6984 # use your CouchDB URL
129129
CLOUDANT_USERNAME=username # replace with your username
130130
CLOUDANT_PASSWORD=password # replace with your password
131131
```

docs/Authentication.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ amending the values with your own
5858
`CLOUDANT_AUTH_TYPE` to `IAM` because it is the default when supplying an `APIKEY`.
5959

6060
```sh
61-
CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL
61+
CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL
6262
CLOUDANT_APIKEY=a1b2c3d4e5f6f1g4h7j3k6l9m2p5q8s1t4v7x0z3 # use your own IAM API key
6363
```
6464

@@ -69,8 +69,8 @@ amending with your own correct values. There is no need to set
6969
`CLOUDANT_AUTH_TYPE` to `CONTAINER` because it is the default.
7070

7171
```sh
72-
CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL
73-
CLOUDANT_IAM_PROFILE_ID=iam-Profile-00000000-aaaa-4444-bbbb-0123456789ab # use your own IAM profile ID
72+
CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL
73+
CLOUDANT_IAM_PROFILE_ID=iam-Profile-00000000-0000-0000-0000-000000000000 # use your own IAM profile ID
7474
```
7575

7676
Alternatives to `CLOUDANT_IAM_PROFILE_ID`:
@@ -83,8 +83,8 @@ amending with your own correct values.
8383

8484
```sh
8585
CLOUDANT_AUTH_TYPE=VPC
86-
CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL
87-
CLOUDANT_IAM_PROFILE_ID=iam-Profile-00000000-aaaa-4444-bbbb-0123456789ab # use your own IAM profile ID
86+
CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL
87+
CLOUDANT_IAM_PROFILE_ID=iam-Profile-00000000-0000-0000-0000-000000000000 # use your own IAM profile ID
8888
```
8989

9090
Alternatives to `CLOUDANT_IAM_PROFILE_ID`:
@@ -98,8 +98,8 @@ amending with your own correct values.
9898

9999
```sh
100100
CLOUDANT_AUTH_TYPE=IAMASSUME
101-
CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL
102-
CLOUDANT_IAM_PROFILE_ID=iam-Profile-00000000-aaaa-4444-bbbb-0123456789ab # use your own IAM profile ID
101+
CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL
102+
CLOUDANT_IAM_PROFILE_ID=iam-Profile-00000000-0000-0000-0000-000000000000 # use your own IAM profile ID
103103
```
104104

105105
Alternatives to `CLOUDANT_IAM_PROFILE_ID`:
@@ -113,7 +113,7 @@ amending with your own [service credentials](https://cloud.ibm.com/docs/Cloudant
113113

114114
```sh
115115
CLOUDANT_AUTH_TYPE=COUCHDB_SESSION
116-
CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL
116+
CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL
117117
CLOUDANT_USERNAME=username # replace with your Cloudant legacy username
118118
CLOUDANT_PASSWORD=password # replace with your Cloudant legacy password or API key (not IAM)
119119
```
@@ -127,7 +127,7 @@ amending with your own correct values.
127127

128128
```sh
129129
CLOUDANT_AUTH_TYPE=BEARERTOKEN
130-
CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL
130+
CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL
131131
CLOUDANT_BEARER_TOKEN=A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c # replace with your bearer token
132132
```
133133

@@ -140,7 +140,7 @@ amending with your own correct values.
140140

141141
```sh
142142
CLOUDANT_AUTH_TYPE=BASIC
143-
CLOUDANT_URL=https://~replaceWithYourUniqueHost~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL
143+
CLOUDANT_URL=https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud # use your own Cloudant public or private URL
144144
CLOUDANT_USERNAME=username # replace with your Cloudant legacy username
145145
CLOUDANT_PASSWORD=password # replace with your Cloudant legacy password or API key (not IAM)
146146
```

examples/README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ service = CloudantV1.new_instance()
308308

309309
response = service.delete_replication_document(
310310
doc_id='repldoc-example',
311-
rev='3-a0ccbdc6fe95b4184f9031d086034d85'
311+
rev='1-00000000000000000000000000000000'
312312
).get_result()
313313

314314
print(response)
@@ -368,18 +368,18 @@ from ibmcloudant.cloudant_v1 import CloudantV1, ReplicationDocument, Replication
368368
service = CloudantV1.new_instance()
369369

370370
source_db = ReplicationDatabase(
371-
url='<your-source-service-url>/animaldb'
371+
url='https://~replace-with-source-host~.cloudantnosqldb.appdomain.cloud/animaldb'
372372
)
373373

374374
target_auth_iam = ReplicationDatabaseAuthIam(
375-
api_key='<your-iam-api-key>'
375+
api_key='a1b2c3d4e5f6f1g4h7j3k6l9m2p5q8s1t4v7x0z3' #use your own IAM API key
376376
)
377377
target_auth = ReplicationDatabaseAuth(
378378
iam=target_auth_iam
379379
)
380380
target_db = ReplicationDatabase(
381381
auth=target_auth,
382-
url='<your-target-service-url>/animaldb-target'
382+
url='https://~replace-with-target-host~.cloudantnosqldb.appdomain.cloud/animaldb-target'
383383
)
384384

385385
replication_document = ReplicationDocument(
@@ -586,7 +586,7 @@ from ibmcloudant.cloudant_v1 import CloudantV1
586586

587587
service = CloudantV1.new_instance()
588588

589-
response = service.delete_database(db='<db-name>').get_result()
589+
response = service.delete_database(db='products').get_result()
590590

591591
print(response)
592592
```
@@ -797,12 +797,12 @@ service = CloudantV1.new_instance()
797797

798798
event_doc_1 = Document(
799799
_id="ns1HJS13AMkK:0007241142412418284",
800-
_rev="1-5005d65514fe9e90f8eccf174af5dd64",
800+
_rev="1-00000000000000000000000000000000",
801801
_deleted=True,
802802
)
803803
event_doc_2 = Document(
804804
_id="H8tDIwfadxp9:0007241142412418285",
805-
_rev="1-2d7810b054babeda4812b3924428d6d6",
805+
_rev="1-00000000000000000000000000000000",
806806
_deleted=True,
807807
)
808808

@@ -873,10 +873,10 @@ service = CloudantV1.new_instance()
873873
doc_id = 'order00067'
874874
bulk_get_doc_1 = BulkGetQueryDocument(
875875
id=doc_id,
876-
rev='3-917fa2381192822767f010b95b45325b')
876+
rev='3-22222222222222222222222222222222')
877877
bulk_get_doc_2 = BulkGetQueryDocument(
878878
id=doc_id,
879-
rev='4-a5be949eeb7296747cc271766e9a498b')
879+
rev='4-33333333333333333333333333333333')
880880

881881
response = service.post_bulk_get(
882882
db='orders',
@@ -915,7 +915,7 @@ service = CloudantV1.new_instance()
915915

916916
bulk_get_doc = BulkGetQueryDocument(
917917
id='order00058',
918-
atts_since=['1-99b02e08da151943c2dcb40090160bb8'])
918+
atts_since=['1-00000000000000000000000000000000'])
919919
response = service.post_bulk_get(
920920
db='orders',
921921
docs=[bulk_get_doc]
@@ -977,7 +977,7 @@ service = CloudantV1.new_instance()
977977
response = service.delete_design_document(
978978
db='products',
979979
ddoc='appliances',
980-
rev='1-98e6a25b3b45df62e7d47095ac15b16a'
980+
rev='1-00000000000000000000000000000000'
981981
).get_result()
982982

983983
print(response)
@@ -1681,9 +1681,9 @@ service = CloudantV1.new_instance()
16811681

16821682
revs_diff = DocumentRevisions(
16831683
order00077=[
1684-
"<1-missing-revision>",
1685-
"<2-missing-revision>",
1686-
"<3-possible-ancestor-revision>"
1684+
"1-00000000000000000000000000000000", # missing revision
1685+
"2-11111111111111111111111111111111", # missing revision
1686+
"3-22222222222222222222222222222222" # possible ancestor revision
16871687
]
16881688
)
16891689

@@ -1804,7 +1804,7 @@ service = CloudantV1.new_instance()
18041804
response = service.delete_document(
18051805
db='orders',
18061806
doc_id='order00058',
1807-
rev='1-99b02e08da151943c2dcb40090160bb8'
1807+
rev='1-00000000000000000000000000000000'
18081808
).get_result()
18091809

18101810
print(response)
@@ -1898,7 +1898,7 @@ response = service.delete_attachment(
18981898
db='products',
18991899
doc_id='1000042',
19001900
attachment_name='product_details.txt',
1901-
rev='4-1a0d1cd6f40472509e9aac646183736a'
1901+
rev='4-33333333333333333333333333333333'
19021902
).get_result()
19031903

19041904
print(response)

examples/snippets/deleteAttachment/example_request.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
db='products',
88
doc_id='1000042',
99
attachment_name='product_details.txt',
10-
rev='4-1a0d1cd6f40472509e9aac646183736a'
10+
rev='4-33333333333333333333333333333333'
1111
).get_result()
1212

1313
print(response)

examples/snippets/deleteDatabase/example_request.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33

44
service = CloudantV1.new_instance()
55

6-
response = service.delete_database(db='<db-name>').get_result()
6+
response = service.delete_database(db='products').get_result()
77

88
print(response)

examples/snippets/deleteDesignDocument/example_request.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
response = service.delete_design_document(
77
db='products',
88
ddoc='appliances',
9-
rev='1-98e6a25b3b45df62e7d47095ac15b16a'
9+
rev='1-00000000000000000000000000000000'
1010
).get_result()
1111

1212
print(response)

examples/snippets/deleteDocument/example_request.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
response = service.delete_document(
77
db='orders',
88
doc_id='order00058',
9-
rev='1-99b02e08da151943c2dcb40090160bb8'
9+
rev='1-00000000000000000000000000000000'
1010
).get_result()
1111

1212
print(response)

examples/snippets/deleteReplicationDocument/example_request.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
response = service.delete_replication_document(
77
doc_id='repldoc-example',
8-
rev='3-a0ccbdc6fe95b4184f9031d086034d85'
8+
rev='1-00000000000000000000000000000000'
99
).get_result()
1010

1111
print(response)

examples/snippets/postBulkDocs/example_request_delete_documents.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55

66
event_doc_1 = Document(
77
_id="ns1HJS13AMkK:0007241142412418284",
8-
_rev="1-5005d65514fe9e90f8eccf174af5dd64",
8+
_rev="1-00000000000000000000000000000000",
99
_deleted=True,
1010
)
1111
event_doc_2 = Document(
1212
_id="H8tDIwfadxp9:0007241142412418285",
13-
_rev="1-2d7810b054babeda4812b3924428d6d6",
13+
_rev="1-00000000000000000000000000000000",
1414
_deleted=True,
1515
)
1616

examples/snippets/postBulkGet/alternative_example_request_for_atts_since.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
bulk_get_doc = BulkGetQueryDocument(
77
id='order00058',
8-
atts_since=['1-99b02e08da151943c2dcb40090160bb8'])
8+
atts_since=['1-00000000000000000000000000000000'])
99
response = service.post_bulk_get(
1010
db='orders',
1111
docs=[bulk_get_doc]

0 commit comments

Comments
 (0)