Skip to content

[DOC-14176]: Feedback on Eventing REST API | Couchbase Docs #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RayOffiah merged 1 commit into from
Mar 27, 2026
Merged

[DOC-14176]: Feedback on Eventing REST API | Couchbase Docs #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .../modules/eventing-rest-api/partials/paths/adv_function_import/curl-request.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.curl request
[source,sh]
----
curl -XPOST -d @./my_function.json \
curl -X POST -d @./my_function.json \
"http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function"
----
====
Expand All @@ -15,7 +15,7 @@ curl -XPOST -d @./my_function.json \
.curl request
[source,sh]
----
curl -XPOST -d @./my_function.json \
curl -X POST -d @./my_function.json \
"http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data"
----
====
2 changes: 1 addition & 1 deletion ...ules/eventing-rest-api/partials/paths/adv_function_import_all/curl-request.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.curl request
[source,sh]
----
curl -XPOST -d @./array_of_functions.json \
curl -X POST -d @./array_of_functions.json \
"http://$USER:$PASSWORD@$HOST:8096/api/v1/functions"
----
====
8 changes: 4 additions & 4 deletions docs/modules/eventing-rest-api/partials/paths/adv_function_view/curl-request.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.curl request
[source,sh]
----
curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function"
curl -X GET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function"
----
====

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

Expand All @@ -23,7 +23,7 @@ curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucke
.curl request
[source,sh]
----
curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function" \
curl -X GET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function" \
-o my_function.json
----
====
Expand All @@ -33,7 +33,7 @@ curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function" \
.curl request
[source,sh]
----
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data" \
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data" \
-o my_function.json
----
====
4 changes: 2 additions & 2 deletions ...odules/eventing-rest-api/partials/paths/adv_function_view_all/curl-request.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.curl request
[source,sh]
----
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions"
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions"
----
====

Expand All @@ -14,7 +14,7 @@ curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions"
.curl request
[source,sh]
----
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions" \
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions" \
-o array_of_functions.json
----
====
4 changes: 2 additions & 2 deletions docs/modules/eventing-rest-api/partials/paths/adv_function_zap/curl-request.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.curl request
[source,sh]
----
curl -XDELETE "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function"
curl -X DELETE "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function"
----
====

Expand All @@ -14,6 +14,6 @@ curl -XDELETE "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function"
.curl request
[source,sh]
----
curl -XDELETE "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data"
curl -X DELETE "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data"
----
====
2 changes: 1 addition & 1 deletion ...modules/eventing-rest-api/partials/paths/adv_function_zap_all/curl-request.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
.curl request
[source,sh]
----
curl -XDELETE "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions"
curl -X DELETE "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions"
----
====
4 changes: 2 additions & 2 deletions .../modules/eventing-rest-api/partials/paths/adv_multiple_export/curl-request.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.curl request
[source,sh]
----
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/export"
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/export"
----
====

Expand All @@ -14,7 +14,7 @@ curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/export"
.curl request
[source,sh]
----
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/export" \
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/export" \
-o array_of_functions.json
----
====
2 changes: 1 addition & 1 deletion .../modules/eventing-rest-api/partials/paths/adv_multiple_import/curl-request.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.curl request
[source,sh]
----
curl -XPOST -d @./array_of_functions.json \
curl -X POST -d @./array_of_functions.json \
"http://$USER:$PASSWORD@$HOST:8096/api/v1/import"
----
====
8 changes: 4 additions & 4 deletions docs/modules/eventing-rest-api/partials/paths/adv_settings_get/curl-request.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.curl request
[source,sh]
----
curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings"
curl -X GET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings"
----
====

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

Expand All @@ -23,7 +23,7 @@ curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/setti
.curl request
[source,sh]
----
curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings" \
curl -X GET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings" \
-o my_function.json
----
====
Expand All @@ -33,7 +33,7 @@ curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/sett
.curl request
[source,sh]
----
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data" \
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data" \
-o my_function.json
----
====
24 changes: 12 additions & 12 deletions .../modules/eventing-rest-api/partials/paths/adv_settings_update/curl-request.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This example updates the `worker_count` setting.
.curl request
[source,sh]
----
curl -XPOST -d '{
curl -X POST -d '{
"deployment_status": false,
"processing_status": false,
"worker_count": 6
Expand All @@ -22,7 +22,7 @@ This example updates the `worker_count` setting.
.curl request
[source,sh]
----
curl -XPOST -d '{
curl -X POST -d '{
"deployment_status": false,
"processing_status": false,
"worker_count": 6
Expand All @@ -38,7 +38,7 @@ The function is currently undeployed.
.curl request
[source,sh]
----
curl -XPOST -d '{
curl -X POST -d '{
"deployment_status": false,
"processing_status": false,
"app_log_max_files": 5
Expand All @@ -55,7 +55,7 @@ The function is currently undeployed.
.curl request
[source,sh]
----
curl -XPOST -d '{
curl -X POST -d '{
"deployment_status": false,
"processing_status": false,
"app_log_max_files": 5,
Expand All @@ -72,7 +72,7 @@ The function is currently paused.
.curl request
[source,sh]
----
curl -XPOST -d '{
curl -X POST -d '{
"deployment_status": true,
"processing_status": false,
"timer_context_size": 2048
Expand All @@ -88,7 +88,7 @@ The function is currently paused.
.curl request
[source,sh]
----
curl -XPOST -d '{
curl -X POST -d '{
"deployment_status": true,
"processing_status": false,
"timer_context_size": 2048
Expand All @@ -104,7 +104,7 @@ The function is currently paused.
.curl request
[source,sh]
----
curl -XPOST -d '{
curl -X POST -d '{
"deployment_status": true,
"processing_status": true,
"worker_count": 8
Expand All @@ -120,7 +120,7 @@ The function is currently paused.
.curl request
[source,sh]
----
curl -XPOST -d '{
curl -X POST -d '{
"deployment_status": true,
"processing_status": true,
"worker_count": 8
Expand All @@ -137,7 +137,7 @@ The function is currently paused.
.curl request
[source,sh]
----
curl -XPOST -d '{
curl -X POST -d '{
"deployment_status": true,
"processing_status": false,
"allow_sync_documents": false
Expand All @@ -156,7 +156,7 @@ The function is currently paused.
.curl request
[source,sh]
----
curl -XPOST -d '{
curl -X POST -d '{
"deployment_status": true,
"processing_status": false,
"allow_sync_documents": false
Expand All @@ -171,7 +171,7 @@ For details, see xref:sync-gateway::server-compatibility-eventing.adoc[].
.curl request
[source,sh]
----
curl -XPOST -d '{
curl -X POST -d '{
"deployment_status": true,
"processing_status": true
}' "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings"
Expand All @@ -186,7 +186,7 @@ See <<basic_deploy>> for the preferred invocation.
.curl request
[source,sh]
----
curl -XPOST -d '{
curl -X POST -d '{
"deployment_status": true,
"processing_status": true
}' "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data"
Expand Down
8 changes: 4 additions & 4 deletions docs/modules/eventing-rest-api/partials/paths/adv_structure_get/curl-request.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.curl request
[source,sh]
----
curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config"
curl -X GET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config"
----
====

Expand All @@ -14,7 +14,7 @@ curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/conf
.curl request
[source,sh]
----
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config?bucket=bulk&scope=data"
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config?bucket=bulk&scope=data"
----
====

Expand All @@ -23,7 +23,7 @@ curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/confi
.curl request
[source,sh]
----
curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config" \
curl -X GET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config" \
-o my_function.json
----
====
Expand All @@ -33,7 +33,7 @@ curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/conf
.curl request
[source,sh]
----
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config?bucket=bulk&scope=data" \
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config?bucket=bulk&scope=data" \
-o my_function.json
----
====
8 changes: 4 additions & 4 deletions ...modules/eventing-rest-api/partials/paths/adv_structure_update/curl-request.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This example alters the source and eventing storage keyspaces.
.curl request
[source,sh]
----
curl -XPOST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config" \
curl -X POST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config" \
-d '{
"source_bucket": "bulk",
"source_scope": "orders",
Expand All @@ -26,7 +26,7 @@ This example alters the source and eventing storage keyspaces.
.curl request
[source,sh]
----
curl -XPOST "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config?bucket=bulk&scope=data"\
curl -X POST "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config?bucket=bulk&scope=data"\
-d '{
"source_bucket": "bulk",
"source_scope": "orders",
Expand All @@ -45,7 +45,7 @@ This example alters the source and eventing storage keyspaces from a file.
.curl request
[source,sh]
----
curl -XPOST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config" \
curl -X POST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config" \
-d @./my_function.json
----
====
Expand All @@ -57,7 +57,7 @@ This example alters the source and eventing storage keyspaces from a file.
.curl request
[source,sh]
----
curl -XPOST "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config?bucket=bulk&scope=data" \
curl -X POST "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config?bucket=bulk&scope=data" \
-d @./my_function.json
----
====
8 changes: 4 additions & 4 deletions docs/modules/eventing-rest-api/partials/paths/adv_text_get/curl-request.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.curl request
[source,sh]
----
curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appcode"
curl -X GET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appcode"
----
====

Expand All @@ -14,7 +14,7 @@ curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appc
.curl request
[source,sh]
----
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appcode?bucket=bulk&scope=data"
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appcode?bucket=bulk&scope=data"
----
====

Expand All @@ -23,7 +23,7 @@ curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appco
.curl request
[source,sh]
----
curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appcode" \
curl -X GET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appcode" \
-o my_function.json
----
====
Expand All @@ -33,7 +33,7 @@ curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appc
.curl request
[source,sh]
----
curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appcode?bucket=bulk&scope=data" \
curl -X GET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appcode?bucket=bulk&scope=data" \
-o my_function.json
----
====
Loading
Loading