|
5 | 5 | title: Couchbase Data API |
6 | 6 | description: |- |
7 | 7 | # Introduction |
8 | | - The Couchbase Capella Data API provides a set of REST APIs for working with data. |
9 | | - It enables users to perform operations such as creating, reading, updating, or deleting data. |
10 | | - It also provides passthrough access to the Couchbase Services REST APIs, which enable you to query your data with SQL++, use vector search for AI applications, and more. |
| 8 | + The Capella Data API provides a RESTful interface for working with data. |
| 9 | + It enables users to perform operations such as creating, reading, updating, or deleting data directly against your cluster. |
| 10 | + It also provides passthrough access to the Couchbase Services REST APIs, which enable you to query your data with SQL+⁠+, use vector search for AI applications, and more. |
11 | 11 | externalDocs: |
12 | 12 | description: Data API Overview |
13 | 13 | url: https://docs.couchbase.com/cloud/data-api-guide/data-api-intro.html |
14 | 14 | tags: |
15 | | - - name: Tools |
| 15 | + - name: Health Check |
16 | 16 | description: General utilities for the Data API. |
17 | | - - name: Single Document Operations |
| 17 | + - name: Basic Document Operations |
18 | 18 | description: Create, read, update, and delete operations for single documents. |
19 | 19 | - name: Binary Operations |
20 | 20 | description: Append, prepend, increment, and decrement operations for binary documents. |
21 | 21 | - name: Locking Operations |
22 | 22 | description: Operations that apply to document locking. |
23 | | - - name: Expiry Operations |
24 | | - description: Operations that apply to document expiry. |
25 | 23 | - name: Sub-Document Operations |
26 | 24 | description: Lookup and mutate operations for fields within a document. |
27 | 25 | paths: |
|
33 | 31 | summary: Get Caller Identity |
34 | 32 | description: Retrieves the identity of the user making the current request. |
35 | 33 | tags: |
36 | | - - Tools |
| 34 | + - Health Check |
37 | 35 | responses: |
38 | 36 | '200': |
39 | 37 | description: Successfully fetched the current caller's identity. |
|
62 | 60 | summary: Get Document |
63 | 61 | description: Retrieves the specified document. |
64 | 62 | tags: |
65 | | - - Single Document Operations |
| 63 | + - Basic Document Operations |
66 | 64 | parameters: |
67 | 65 | - $ref: '#/components/parameters/AcceptEncodingHeader' |
68 | 66 | - in: query |
@@ -164,7 +162,7 @@ paths: |
164 | 162 | summary: Create Document |
165 | 163 | description: Creates a document with the given ID and contents. |
166 | 164 | tags: |
167 | | - - Single Document Operations |
| 165 | + - Basic Document Operations |
168 | 166 | parameters: |
169 | 167 | - $ref: '#/components/parameters/ContentEncodingHeader' |
170 | 168 | - $ref: '#/components/parameters/ExpiresHeader' |
@@ -207,7 +205,7 @@ paths: |
207 | 205 | summary: Update Document |
208 | 206 | description: Updates the specified document with the given contents. |
209 | 207 | tags: |
210 | | - - Single Document Operations |
| 208 | + - Basic Document Operations |
211 | 209 | parameters: |
212 | 210 | - $ref: '#/components/parameters/ContentEncodingHeader' |
213 | 211 | - $ref: '#/components/parameters/IfMatchHeader' |
@@ -251,7 +249,7 @@ paths: |
251 | 249 | summary: Delete Document |
252 | 250 | description: Deletes the specified document. |
253 | 251 | tags: |
254 | | - - Single Document Operations |
| 252 | + - Basic Document Operations |
255 | 253 | parameters: |
256 | 254 | - $ref: '#/components/parameters/IfMatchHeader' |
257 | 255 | - $ref: '#/components/parameters/DurabilityLevelHeader' |
@@ -284,7 +282,7 @@ paths: |
284 | 282 | summary: Check Alpha API |
285 | 283 | description: Checks whether the alpha API is enabled. |
286 | 284 | tags: |
287 | | - - Tools |
| 285 | + - Health Check |
288 | 286 | responses: |
289 | 287 | '200': |
290 | 288 | description: The alpha API is enabled |
@@ -666,9 +664,11 @@ paths: |
666 | 664 | post: |
667 | 665 | operationId: touchDocument |
668 | 666 | summary: Touch Document |
669 | | - description: Updates the expiry of a document. |
| 667 | + description: |- |
| 668 | + Updates the expiry of a document. |
| 669 | + For details, see [Expiration](https://docs.couchbase.com/server/current/learn/data/expiration.html). |
670 | 670 | tags: |
671 | | - - Expiry Operations |
| 671 | + - Basic Document Operations |
672 | 672 | parameters: |
673 | 673 | - $ref: '#/components/parameters/AcceptEncodingHeader' |
674 | 674 | requestBody: |
|
0 commit comments