Skip to content

AV-102698: Add passthroughs to Data API documentation #172

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
simon-dew merged 8 commits into from
Jul 9, 2025
Merged

AV-102698: Add passthroughs to Data API documentation #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d0cc1b1
Add tags so operations appear in the Data API
simon-dew May 29, 2025
dee52b0
Add query examples
simon-dew May 29, 2025
3f35c98
Add additional property name
simon-dew May 29, 2025
967b57c
Minor nits
simon-dew May 30, 2025
f8c3ba7
More minor nits
simon-dew May 30, 2025
f2ede28
Revert "Add tags so operations appear in the Data API"
simon-dew Jul 9, 2025
790c85e
Build output documentation
tech-comm-team-couchbase Jul 9, 2025
5aebf1e
Update Base URLs and credentials
simon-dew Jul 9, 2025
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
3 changes: 3 additions & 0 deletions docs/modules/n1ql-rest-query/examples/exformdata.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
curl -v $BASEURL/_p/query/query/service \
-d 'statement=SELECT name FROM `travel-sample`.inventory.hotel LIMIT 1' \
-u $USER:$PASSWORD
18 changes: 18 additions & 0 deletions docs/modules/n1ql-rest-query/examples/exn1qlerror.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"requestID": "27087759-07af-431d-a3d7-29080f870e56",
"errors": [
{
"code": 3000,
"msg": "syntax error - line 1, column 7, near 'SLECT', at: name"
}
],
"status": "fatal",
"metrics": {
"elapsedTime": "1.478631ms",
"executionTime": "1.393274ms",
"resultCount": 0,
"resultSize": 0,
"serviceLoad": 12,
"errorCount": 1
}
}
25 changes: 25 additions & 0 deletions docs/modules/n1ql-rest-query/examples/exnamed.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"requestID": "81aceab8-7f7a-4d00-b741-00385740329a",
"signature": {
"airline": "json"
},
"results": [
{
"airline": "B6"
},
{
"airline": "EK"
},
{
"airline": "SV"
}
],
"status": "success",
"metrics": {
"elapsedTime": "72.886709ms",
"executionTime": "72.765333ms",
"resultCount": 3,
"resultSize": 48,
"serviceLoad": 12
}
}
5 changes: 5 additions & 0 deletions docs/modules/n1ql-rest-query/examples/exnamed.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
curl -v $BASEURL/_p/query/query/service \
-d 'statement=SELECT airline FROM `travel-sample`.inventory.route
WHERE sourceairport = $aval AND distance > $dval
& $aval="LAX" & $dval=13000' \
-u $USER:$PASSWORD
18 changes: 18 additions & 0 deletions docs/modules/n1ql-rest-query/examples/exnotfound.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"requestID": "d30b805f-6c1e-44ec-9aec-35ff711a6e88",
"errors": [
{
"code": 12003,
"msg": "Keyspace not found in CB datastore: default:travel-sample.inventory.motel"
}
],
"status": "fatal",
"metrics": {
"elapsedTime": "3.096786ms",
"executionTime": "2.468282ms",
"resultCount": 0,
"resultSize": 0,
"serviceLoad": 12,
"errorCount": 1
}
}
25 changes: 25 additions & 0 deletions docs/modules/n1ql-rest-query/examples/exnumbered.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"requestID": "6e242629-ebf5-4a58-8db4-62d94974519f",
"signature": {
"airline": "json"
},
"results": [
{
"airline": "B6"
},
{
"airline": "EK"
},
{
"airline": "SV"
}
],
"status": "success",
"metrics": {
"elapsedTime": "86.962678ms",
"executionTime": "84.35715ms",
"resultCount": 3,
"resultSize": 48,
"serviceLoad": 12
}
}
5 changes: 5 additions & 0 deletions docs/modules/n1ql-rest-query/examples/exnumbered.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
curl -v $BASEURL/_p/query/query/service \
-d 'statement=SELECT airline FROM `travel-sample`.inventory.route
WHERE sourceairport = $1 AND distance > $2
& args=["LAX", 13000]' \
-u $USER:$PASSWORD
25 changes: 25 additions & 0 deletions docs/modules/n1ql-rest-query/examples/expositional.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"requestID": "6d77dc41-3cab-4e00-9c54-f60fcc2e0fab",
"signature": {
"airline": "json"
},
"results": [
{
"airline": "B6"
},
{
"airline": "EK"
},
{
"airline": "SV"
}
],
"status": "success",
"metrics": {
"elapsedTime": "86.226474ms",
"executionTime": "86.072996ms",
"resultCount": 3,
"resultSize": 48,
"serviceLoad": 12
}
}
5 changes: 5 additions & 0 deletions docs/modules/n1ql-rest-query/examples/expositional.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
curl -v $BASEURL/_p/query/query/service \
-d 'statement=SELECT airline FROM `travel-sample`.inventory.route
WHERE sourceairport = ? AND distance > ?
& args=["LAX", 13000]' \
-u $USER:$PASSWORD
2 changes: 2 additions & 0 deletions docs/modules/n1ql-rest-query/examples/exreadonly.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
curl -v $BASEURL/_p/query/query/service?statement=SELECT%20name%20FROM%20%60travel-sample%60.inventory.hotel%20LIMIT%201%3B \
-u $USER:$PASSWORD
18 changes: 18 additions & 0 deletions docs/modules/n1ql-rest-query/examples/exrequesterror.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"requestID": "424c0a6d-b851-4feb-892c-0d9a106f2e13",
"errors": [
{
"code": 1050,
"msg": "No statement or prepared value"
}
],
"status": "fatal",
"metrics": {
"elapsedTime": "1.124637ms",
"executionTime": "1.094663ms",
"resultCount": 0,
"resultSize": 0,
"serviceLoad": 0,
"errorCount": 1
}
}
19 changes: 19 additions & 0 deletions docs/modules/n1ql-rest-query/examples/exserviceerror.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"requestID": "5c0a6a81-2fc8-4a33-a035-ed7fb1512710",
"errors": [
{
"code": "<int>",
"msg": "Request queue full"
}
],
"status": "errors",
"metrics": {
"elapsedTime": "134.7944us",
"executionTime": "130.5518us",
"resultCount": 0,
"resultSize": 0,
"mutationCount": 0,
"errorCount": 1,
"warningCount": 0
}
}
19 changes: 19 additions & 0 deletions docs/modules/n1ql-rest-query/examples/exsuccessful.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"requestID": "615e0b26-dd61-4a1a-bda9-22333193b982",
"signature": {
"name": "json"
},
"results": [
{
"name": "Medway Youth Hostel"
}
],
"status": "success",
"metrics": {
"elapsedTime": "5.232754ms",
"executionTime": "5.160022ms",
"resultCount": 1,
"resultSize": 30,
"serviceLoad": 12
}
}
4 changes: 4 additions & 0 deletions docs/modules/n1ql-rest-query/examples/exsuccessful.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
curl -v $BASEURL/_p/query/query/service \
-H 'Content-Type: application/json' \
-d '{ "statement": "SELECT name FROM `travel-sample`.inventory.hotel LIMIT 1;" }' \
-u $USER:$PASSWORD
22 changes: 22 additions & 0 deletions docs/modules/n1ql-rest-query/examples/exwildcard.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"requestID": "716f5e7b-557a-44a6-a372-9a98611c5b5e",
"signature": {
"id": "json"
},
"results": [
{
"id": "hotel_10025"
},
{
"id": "hotel_10026"
}
],
"status": "success",
"metrics": {
"elapsedTime": "64.11756ms",
"executionTime": "63.993854ms",
"resultCount": 2,
"resultSize": 40,
"serviceLoad": 12
}
}
6 changes: 6 additions & 0 deletions docs/modules/n1ql-rest-query/examples/exwildcard.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
curl -v $BASEURL/_p/query/query/service \
-u $USER:$PASSWORD \
-d 'statement=SELECT meta().id
FROM `travel-sample`.inventory.hotel
WHERE meta().id LIKE $pattern
& $pattern="hotel_1002%25"'
28 changes: 20 additions & 8 deletions docs/modules/n1ql-rest-query/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,9 +270,11 @@ a| <<Response>>
| 400
a| [markdown]
--
Bad Request. The request cannot be processed for one of the following reasons: the statement contains a SQL++ syntax error; the request has a missing or unrecognized HTTP parameter; the request is badly formatted &mdash; for example, the request body contains a JSON syntax error.
Bad Request. The request cannot be processed for one of the following reasons: the statement contains a SQL++ syntax error; the request has a missing or unrecognized HTTP parameter; the request is badly formatted &mdash; for example, the request body contains a JSON syntax error.
--
a|
a| <<Response>>


| 401
a| [markdown]
--
Expand All @@ -290,7 +292,9 @@ a| [markdown]
--
Not found. The statement in the request references an invalid namespace or keyspace.
--
a|
a| <<Response>>


| 405
a| [markdown]
--
Expand Down Expand Up @@ -326,7 +330,9 @@ a| [markdown]
--
Service unavailable. There is an issue (that is possibly temporary) preventing the request being processed; the request queue is full or the data store is not accessible.
--
a|
a| <<Response>>



|===

Expand Down Expand Up @@ -524,9 +530,11 @@ a| <<Response>>
| 400
a| [markdown]
--
Bad Request. The request cannot be processed for one of the following reasons: the statement contains a SQL++ syntax error; the request has a missing or unrecognized HTTP parameter; the request is badly formatted &mdash; for example, the request body contains a JSON syntax error.
Bad Request. The request cannot be processed for one of the following reasons: the statement contains a SQL++ syntax error; the request has a missing or unrecognized HTTP parameter; the request is badly formatted &mdash; for example, the request body contains a JSON syntax error.
--
a|
a| <<Response>>


| 401
a| [markdown]
--
Expand All @@ -544,7 +552,9 @@ a| [markdown]
--
Not found. The statement in the request references an invalid namespace or keyspace.
--
a|
a| <<Response>>


| 405
a| [markdown]
--
Expand Down Expand Up @@ -580,7 +590,9 @@ a| [markdown]
--
Service unavailable. There is an issue (that is possibly temporary) preventing the request being processed; the request queue is full or the data store is not accessible.
--
a|
a| <<Response>>



|===

Expand Down
Loading