Skip to content

Commit 939e0aa

Browse files
jhlodinjhlodin
committed
Apply consistent usage of double quotes for example API requests
1 parent 8769735 commit 939e0aa

File tree

55 files changed

+230
-230
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+230
-230
lines changed

‎src/current/_includes/cockroachcloud/backups/cloud-api-backup-settings.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ To retrieve information about a specific cluster, make a `GET` request to the `/
66
~~~ shell
77
curl --request GET \
88
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/backups-config \
9-
--header 'Authorization: Bearer {secret_key}'
9+
--header "Authorization: Bearer {secret_key}"
1010
~~~
1111

1212
Set the following:
@@ -42,8 +42,8 @@ To configure the frequency and retention of managed backups, send a `PUT` reques
4242
~~~ shell
4343
curl --request PUT \
4444
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/backups-config \
45-
--header 'Authorization: Bearer {secret_key}' \
46-
--data '{"enabled": true, "frequency_minutes": 30, "retention_days": 2}'
45+
--header "Authorization: Bearer {secret_key}" \
46+
--data "{"enabled": true, "frequency_minutes": 30, "retention_days": 2}"
4747
~~~
4848

4949
Set the following:

‎src/current/_includes/cockroachcloud/backups/cloud-api-backup-view.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To view a list of managed backups on a cluster with timestamps and their respect
1010
~~~ shell
1111
curl --request GET \
1212
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/backups \
13-
--header 'Authorization: Bearer {secret_key}' \
13+
--header "Authorization: Bearer {secret_key}" \
1414
~~~
1515

1616
If the request is successful, the client recieves a JSON response listing backups with their unique `{id}`. The `{as_of_time}` timestamp describes the system time of the cluster when the backup was created:

‎src/current/_includes/cockroachcloud/backups/cloud-api-restore-endpoint.md‎

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,25 @@ To restore a cluster to a recent managed backup, send a `POST` request to the `/
2323
{% include_cached copy-clipboard.html %}
2424
~~~ shell
2525
curl --request POST \
26-
--url 'https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores' \
26+
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
2727
--header "Authorization: Bearer {secret_key}" \
28-
--json '{
28+
--json "{
2929
"source_cluster_id": "{cluster_id}",
3030
"type": "CLUSTER"
31-
}'
31+
}"
3232
~~~
3333

3434
By default, the restore job uses the most recent backup stored within the last 7 days on the cluster specified in `source_cluster_id`. To restore a specific backup, include the `backup_id` field and specify a backup ID from the [managed backups list](#view-managed-backups):
3535

3636
{% include_cached copy-clipboard.html %}
3737
~~~ shell
3838
curl --request POST \
39-
--url 'https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores' \
39+
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
4040
--header "Authorization: Bearer {secret_key}" \
41-
--json '{
41+
--json "{
4242
"backup_id": "example-2d25-4a64-8172-28af7a0d41cc",
4343
"type": "CLUSTER"
44-
}'
44+
}"
4545
~~~
4646

4747
{% if page.name == "managed-backups-advanced.md" %}
@@ -50,12 +50,12 @@ To restore a cluster backup into a different cluster, ensure that the destinatio
5050
{% include_cached copy-clipboard.html %}
5151
~~~ shell
5252
curl --request POST \
53-
--url 'https://cockroachlabs.cloud/api/v1/clusters/{destination_cluster_id}/restores' \
53+
--url https://cockroachlabs.cloud/api/v1/clusters/{destination_cluster_id}/restores \
5454
--header "Authorization: Bearer {secret_key}" \
55-
--json '{
55+
--json "{
5656
"source_cluster_id": "{source_cluster_id}",
5757
"type": "CLUSTER"
58-
}'
58+
}"
5959
~~~
6060

6161
You can specify additional options for the restore job in the `restore_opts` object. For more information, see the [API endpoint documentation](https://www.cockroachlabs.com/docs/api/cloud/v1#get-/api/v1/clusters/-cluster_id-/restores-config).
@@ -83,9 +83,9 @@ To restore one or more databases from a cluster's managed backup, send a `POST`
8383
{% include_cached copy-clipboard.html %}
8484
~~~ shell
8585
curl --request POST \
86-
--url 'https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores' \
86+
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
8787
--header "Authorization: Bearer {secret_key}" \
88-
--json '{
88+
--json "{
8989
"source_cluster_id": "{cluster_id}",
9090
"type": "DATABASE",
9191
"objects": [
@@ -96,17 +96,17 @@ curl --request POST \
9696
"database": "movr"
9797
}
9898
]
99-
}'
99+
}"
100100
~~~
101101

102102
By default, the database is restored into the original database name from the managed backup. To restore the database contents into a new database, include the field `restore_opts.new_db_name` with the new database name. You can only restore one database at a time when using this option.
103103

104104
{% include_cached copy-clipboard.html %}
105105
~~~ shell
106106
curl --request POST \
107-
--url 'https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores' \
107+
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
108108
--header "Authorization: Bearer {secret_key}" \
109-
--json '{
109+
--json "{
110110
"source_cluster_id": "{cluster_id}",
111111
"type": "DATABASE",
112112
"objects": [
@@ -117,43 +117,43 @@ curl --request POST \
117117
"restore_opts": {
118118
"new_db_name": "tpcc2"
119119
}
120-
}'
120+
}"
121121
~~~
122122

123123
To restore from a specific backup rather than the most recently created managed backup, include the `backup_id` field specifying a backup ID:
124124

125125
{% include_cached copy-clipboard.html %}
126126
~~~ shell
127127
curl --request POST \
128-
--url 'https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores' \
128+
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
129129
--header "Authorization: Bearer {secret_key}" \
130-
--json '{
130+
--json "{
131131
"backup_id": "example-2d25-4a64-8172-28af7a0d41cc",
132132
"type": "DATABASE",
133133
"objects": [
134134
{
135135
"database": "tpcc"
136136
}
137-
],
138-
}'
137+
]
138+
}"
139139
~~~
140140

141141
To restore a database from a source cluster's managed backup into a different cluster, send the restore request to the destination cluster ID. Specify the ID of the backup's cluster as `source_cluster_id`. Both the source cluster and the destination cluster must use the Advanced plan.
142142

143143
{% include_cached copy-clipboard.html %}
144144
~~~ shell
145145
curl --request POST \
146-
--url 'https://cockroachlabs.cloud/api/v1/clusters/{destination_cluster_id}/restores' \
146+
--url https://cockroachlabs.cloud/api/v1/clusters/{destination_cluster_id}/restores \
147147
--header "Authorization: Bearer {secret_key}" \
148-
--json '{
148+
--json "{
149149
"source_cluster_id": "{source_cluster_id}",
150150
"type": "DATABASE",
151151
"objects": [
152152
{
153153
"database": "tpcc"
154154
}
155-
],
156-
}'
155+
]
156+
}"
157157
~~~
158158

159159
You can specify additional options for the restore jobs in the `restore_opts` object. For more information, see the [API endpoint documentation](https://www.cockroachlabs.com/docs/api/cloud/v1#get-/api/v1/clusters/-cluster_id-/restores-config).
@@ -178,9 +178,9 @@ To restore a one or more tables from a cluster's managed backup, send a `POST` r
178178
{% include_cached copy-clipboard.html %}
179179
~~~ shell
180180
curl --request POST \
181-
--url 'https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores' \
181+
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
182182
--header "Authorization: Bearer {secret_key}" \
183-
--json '{
183+
--json "{
184184
"source_cluster_id": "{cluster_id}",
185185
"type": "TABLE",
186186
"objects": [
@@ -195,17 +195,17 @@ curl --request POST \
195195
"table": "customer"
196196
}
197197
]
198-
}'
198+
}"
199199
~~~
200200

201201
By default, the table is restored into the original database name from the managed backup. To restore the table into a different database, include the field `restore_opts.into_db` with the desired database name. The following example restores the `tpcc.public.warehouse` table from the most recent managed backup into `tpcc2.public.warehouse` on the cluster:
202202

203203
{% include_cached copy-clipboard.html %}
204204
~~~ shell
205205
curl --request POST \
206-
--url 'https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores' \
206+
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
207207
--header "Authorization: Bearer {secret_key}" \
208-
--json '{
208+
--json "{
209209
"source_cluster_id": "{cluster_id}",
210210
"type": "TABLE",
211211
"objects": [
@@ -223,17 +223,17 @@ curl --request POST \
223223
"restore_opts": {
224224
"into_db": "tpcc2"
225225
}
226-
}'
226+
}"
227227
~~~
228228

229229
To restore from a specific backup rather than the most recently created managed backup, include the `backup_id` field specifying a backup ID:
230230

231231
{% include_cached copy-clipboard.html %}
232232
~~~ shell
233233
curl --request POST \
234-
--url 'https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores' \
234+
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores \
235235
--header "Authorization: Bearer {secret_key}" \
236-
--json '{
236+
--json "{
237237
"backup_id": "example-2d25-4a64-8172-28af7a0d41cc",
238238
"type": "TABLE",
239239
"objects": [
@@ -243,17 +243,17 @@ curl --request POST \
243243
"table": "warehouse"
244244
}
245245
]
246-
}'
246+
}"
247247
~~~
248248

249249
To restore a table from a source cluster's managed backup into a different cluster, send the restore request to the destination cluster ID. Specify the ID of the backup's cluster as `source_cluster_id`. Both the source cluster and the destination cluster must use the Advanced plan.
250250

251251
{% include_cached copy-clipboard.html %}
252252
~~~ shell
253253
curl --request POST \
254-
--url 'https://cockroachlabs.cloud/api/v1/clusters/{destination_cluster_id}/restores' \
254+
--url https://cockroachlabs.cloud/api/v1/clusters/{destination_cluster_id}/restores \
255255
--header "Authorization: Bearer {secret_key}" \
256-
--json '{
256+
--json "{
257257
"source_cluster_id": "{source_cluster_id}",
258258
"type": "TABLE",
259259
"objects": [
@@ -263,7 +263,7 @@ curl --request POST \
263263
"table": "warehouse"
264264
}
265265
]
266-
}'
266+
}"
267267
~~~
268268

269269
You can specify additional options for the restore jobs in the `restore_opts` object. For more information, see the [API endpoint documentation](https://www.cockroachlabs.com/docs/api/cloud/v1#get-/api/v1/clusters/-cluster_id-/restores-config).
@@ -294,7 +294,7 @@ To view the status of a restore job using the cloud API, send a `GET` request to
294294
~~~ shell
295295
curl --request GET \
296296
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/restores/{restore_id} \
297-
--header 'Authorization: Bearer {secret_key}'
297+
--header "Authorization: Bearer {secret_key}"
298298
~~~
299299

300300
If the request is successful, the client recieves a response containing JSON describing the status of the specified request operation:

‎src/current/cockroachcloud/aws-privatelink.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ To [add a private endpoint trusted owner](https://www.cockroachlabs.com/docs/api
7878
~~~ shell
7979
curl --request POST \
8080
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners \
81-
--header 'Authorization: Bearer {bearer_token' \
82-
--header 'content-type: application/json' \
83-
--data '{"external_owner_id":"{aws_account_id}","type":"AWS_ACCOUNT_ID"}'
81+
--header "Authorization: Bearer {bearer_token}" \
82+
--header "content-type: application/json" \
83+
--data "{"external_owner_id":"{aws_account_id}","type":"AWS_ACCOUNT_ID"}"
8484
~~~
8585

8686
Replace:
@@ -101,7 +101,7 @@ To [list private endpoint trusted owners](https://www.cockroachlabs.com/docs/api
101101
~~~ shell
102102
curl --request GET \
103103
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners \
104-
--header 'Authorization: Bearer {bearer_token}'
104+
--header "Authorization: Bearer {bearer_token}"
105105
~~~
106106

107107
Replace:
@@ -117,7 +117,7 @@ To [get details about a private endpoint trusted owner](https://www.cockroachlab
117117
~~~ shell
118118
curl --request GET \
119119
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners/{owner_id} \
120-
--header 'Authorization: Bearer {bearer_token}'
120+
--header "Authorization: Bearer {bearer_token}"
121121
~~~
122122

123123
Replace:
@@ -134,7 +134,7 @@ To [remove a private endpoint trusted owner](https://www.cockroachlabs.com/docs/
134134
~~~ shell
135135
curl --request DELETE \
136136
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners/{owner_id} \
137-
--header 'Authorization: {bearer_token}'
137+
--header "Authorization: {bearer_token}"
138138
~~~
139139

140140
Replace:

‎src/current/cockroachcloud/client-certs-advanced.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ The [Cluster Admin]({% link cockroachcloud/authorization.md %}#cluster-admin) or
183183
curl --request POST \
184184
--url ${COCKROACH_SERVER}/api/v1/clusters/${CLUSTER_ID}/client-ca-cert \
185185
--header "Authorization: Bearer ${API_KEY}" \
186-
--header 'content-type: application/json' \
186+
--header "content-type: application/json" \
187187
--data "@cockroach_client_ca_cert.json"
188188
~~~
189189
@@ -263,7 +263,7 @@ The [Cluster Admin]({% link cockroachcloud/authorization.md %}#cluster-admin) or
263263
curl --request PATCH \
264264
--url ${COCKROACH_SERVER}/api/v1/clusters/${CLUSTER_ID}/client-ca-cert \
265265
--header "Authorization: Bearer ${API_KEY}" \
266-
--header 'content-type: application/json' \
266+
--header "content-type: application/json" \
267267
--data "@cockroach_client_ca_cert.json"
268268
~~~
269269

0 commit comments

Comments
 (0)