Skip to content

Commit a2cd6ca

Browse files
RayOffiahRayOffiah
authored
[DOC-14176]: Feedback on Eventing REST API | Couchbase Docs (#210)
Fixed `CURL` statements. Signed-off-by: Ray Offiah <ray.offiah@couchbase.com>
1 parent a56d309 commit a2cd6ca

30 files changed

Lines changed: 86 additions & 86 deletions

File tree

‎docs/modules/eventing-rest-api/partials/paths/adv_function_import/curl-request.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
.curl request
66
[source,sh]
77
----
8-
curl -XPOST -d @./my_function.json \
8+
curl -X POST -d @./my_function.json \
99
"http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function"
1010
----
1111
====
@@ -15,7 +15,7 @@ curl -XPOST -d @./my_function.json \
1515
.curl request
1616
[source,sh]
1717
----
18-
curl -XPOST -d @./my_function.json \
18+
curl -X POST -d @./my_function.json \
1919
"http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data"
2020
----
2121
====

‎docs/modules/eventing-rest-api/partials/paths/adv_function_import_all/curl-request.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
.curl request
66
[source,sh]
77
----
8-
curl -XPOST -d @./array_of_functions.json \
8+
curl -X POST -d @./array_of_functions.json \
99
"http://$USER:$PASSWORD@$HOST:8096/api/v1/functions"
1010
----
1111
====

‎docs/modules/eventing-rest-api/partials/paths/adv_function_view/curl-request.adoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
.curl request
66
[source,sh]
77
----
8-
curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function"
8+
curl -X GET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function"
99
----
1010
====
1111

@@ -14,7 +14,7 @@ curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function"
1414
.curl request
1515
[source,sh]
1616
----
17-
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data"
17+
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data"
1818
----
1919
====
2020

@@ -23,7 +23,7 @@ curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucke
2323
.curl request
2424
[source,sh]
2525
----
26-
curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function" \
26+
curl -X GET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function" \
2727
-o my_function.json
2828
----
2929
====
@@ -33,7 +33,7 @@ curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function" \
3333
.curl request
3434
[source,sh]
3535
----
36-
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data" \
36+
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data" \
3737
-o my_function.json
3838
----
3939
====

‎docs/modules/eventing-rest-api/partials/paths/adv_function_view_all/curl-request.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
.curl request
66
[source,sh]
77
----
8-
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions"
8+
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions"
99
----
1010
====
1111

@@ -14,7 +14,7 @@ curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions"
1414
.curl request
1515
[source,sh]
1616
----
17-
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions" \
17+
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions" \
1818
-o array_of_functions.json
1919
----
2020
====

‎docs/modules/eventing-rest-api/partials/paths/adv_function_zap/curl-request.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
.curl request
66
[source,sh]
77
----
8-
curl -XDELETE "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function"
8+
curl -X DELETE "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function"
99
----
1010
====
1111

@@ -14,6 +14,6 @@ curl -XDELETE "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function"
1414
.curl request
1515
[source,sh]
1616
----
17-
curl -XDELETE "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data"
17+
curl -X DELETE "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data"
1818
----
1919
====

‎docs/modules/eventing-rest-api/partials/paths/adv_function_zap_all/curl-request.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
.curl request
66
[source,sh]
77
----
8-
curl -XDELETE "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions"
8+
curl -X DELETE "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions"
99
----
1010
====

‎docs/modules/eventing-rest-api/partials/paths/adv_multiple_export/curl-request.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
.curl request
66
[source,sh]
77
----
8-
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/export"
8+
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/export"
99
----
1010
====
1111

@@ -14,7 +14,7 @@ curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/export"
1414
.curl request
1515
[source,sh]
1616
----
17-
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/export" \
17+
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/export" \
1818
-o array_of_functions.json
1919
----
2020
====

‎docs/modules/eventing-rest-api/partials/paths/adv_multiple_import/curl-request.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
.curl request
66
[source,sh]
77
----
8-
curl -XPOST -d @./array_of_functions.json \
8+
curl -X POST -d @./array_of_functions.json \
99
"http://$USER:$PASSWORD@$HOST:8096/api/v1/import"
1010
----
1111
====

‎docs/modules/eventing-rest-api/partials/paths/adv_settings_get/curl-request.adoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
.curl request
66
[source,sh]
77
----
8-
curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings"
8+
curl -X GET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings"
99
----
1010
====
1111

@@ -14,7 +14,7 @@ curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/sett
1414
.curl request
1515
[source,sh]
1616
----
17-
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data"
17+
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data"
1818
----
1919
====
2020

@@ -23,7 +23,7 @@ curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/setti
2323
.curl request
2424
[source,sh]
2525
----
26-
curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings" \
26+
curl -X GET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings" \
2727
-o my_function.json
2828
----
2929
====
@@ -33,7 +33,7 @@ curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/sett
3333
.curl request
3434
[source,sh]
3535
----
36-
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data" \
36+
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data" \
3737
-o my_function.json
3838
----
3939
====

‎docs/modules/eventing-rest-api/partials/paths/adv_settings_update/curl-request.adoc‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This example updates the `worker_count` setting.
77
.curl request
88
[source,sh]
99
----
10-
curl -XPOST -d '{
10+
curl -X POST -d '{
1111
"deployment_status": false,
1212
"processing_status": false,
1313
"worker_count": 6
@@ -22,7 +22,7 @@ This example updates the `worker_count` setting.
2222
.curl request
2323
[source,sh]
2424
----
25-
curl -XPOST -d '{
25+
curl -X POST -d '{
2626
"deployment_status": false,
2727
"processing_status": false,
2828
"worker_count": 6
@@ -38,7 +38,7 @@ The function is currently undeployed.
3838
.curl request
3939
[source,sh]
4040
----
41-
curl -XPOST -d '{
41+
curl -X POST -d '{
4242
"deployment_status": false,
4343
"processing_status": false,
4444
"app_log_max_files": 5
@@ -55,7 +55,7 @@ The function is currently undeployed.
5555
.curl request
5656
[source,sh]
5757
----
58-
curl -XPOST -d '{
58+
curl -X POST -d '{
5959
"deployment_status": false,
6060
"processing_status": false,
6161
"app_log_max_files": 5,
@@ -72,7 +72,7 @@ The function is currently paused.
7272
.curl request
7373
[source,sh]
7474
----
75-
curl -XPOST -d '{
75+
curl -X POST -d '{
7676
"deployment_status": true,
7777
"processing_status": false,
7878
"timer_context_size": 2048
@@ -88,7 +88,7 @@ The function is currently paused.
8888
.curl request
8989
[source,sh]
9090
----
91-
curl -XPOST -d '{
91+
curl -X POST -d '{
9292
"deployment_status": true,
9393
"processing_status": false,
9494
"timer_context_size": 2048
@@ -104,7 +104,7 @@ The function is currently paused.
104104
.curl request
105105
[source,sh]
106106
----
107-
curl -XPOST -d '{
107+
curl -X POST -d '{
108108
"deployment_status": true,
109109
"processing_status": true,
110110
"worker_count": 8
@@ -120,7 +120,7 @@ The function is currently paused.
120120
.curl request
121121
[source,sh]
122122
----
123-
curl -XPOST -d '{
123+
curl -X POST -d '{
124124
"deployment_status": true,
125125
"processing_status": true,
126126
"worker_count": 8
@@ -137,7 +137,7 @@ The function is currently paused.
137137
.curl request
138138
[source,sh]
139139
----
140-
curl -XPOST -d '{
140+
curl -X POST -d '{
141141
"deployment_status": true,
142142
"processing_status": false,
143143
"allow_sync_documents": false
@@ -156,7 +156,7 @@ The function is currently paused.
156156
.curl request
157157
[source,sh]
158158
----
159-
curl -XPOST -d '{
159+
curl -X POST -d '{
160160
"deployment_status": true,
161161
"processing_status": false,
162162
"allow_sync_documents": false
@@ -171,7 +171,7 @@ For details, see xref:sync-gateway::server-compatibility-eventing.adoc[].
171171
.curl request
172172
[source,sh]
173173
----
174-
curl -XPOST -d '{
174+
curl -X POST -d '{
175175
"deployment_status": true,
176176
"processing_status": true
177177
}' "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings"
@@ -186,7 +186,7 @@ See <<basic_deploy>> for the preferred invocation.
186186
.curl request
187187
[source,sh]
188188
----
189-
curl -XPOST -d '{
189+
curl -X POST -d '{
190190
"deployment_status": true,
191191
"processing_status": true
192192
}' "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data"

0 commit comments

Comments
 (0)