Skip to content

Commit f75f876

Browse files
simon-dewWestwooo
authored andcommitted
ING-1293: Update spec with docs feedback
Update spec description Rename Tools → Health Check Rename Single Document Operations → Basic Document Operations Include Touch in Basic Document Operations Explain purpose of Touch
1 parent 693bd8d commit f75f876

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

dataapiv1/spec.yaml

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,21 @@ info:
55
title: Couchbase Data API
66
description: |-
77
# 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.
1111
externalDocs:
1212
description: Data API Overview
1313
url: https://docs.couchbase.com/cloud/data-api-guide/data-api-intro.html
1414
tags:
15-
- name: Tools
15+
- name: Health Check
1616
description: General utilities for the Data API.
17-
- name: Single Document Operations
17+
- name: Basic Document Operations
1818
description: Create, read, update, and delete operations for single documents.
1919
- name: Binary Operations
2020
description: Append, prepend, increment, and decrement operations for binary documents.
2121
- name: Locking Operations
2222
description: Operations that apply to document locking.
23-
- name: Expiry Operations
24-
description: Operations that apply to document expiry.
2523
- name: Sub-Document Operations
2624
description: Lookup and mutate operations for fields within a document.
2725
paths:
@@ -33,7 +31,7 @@ paths:
3331
summary: Get Caller Identity
3432
description: Retrieves the identity of the user making the current request.
3533
tags:
36-
- Tools
34+
- Health Check
3735
responses:
3836
'200':
3937
description: Successfully fetched the current caller's identity.
@@ -62,7 +60,7 @@ paths:
6260
summary: Get Document
6361
description: Retrieves the specified document.
6462
tags:
65-
- Single Document Operations
63+
- Basic Document Operations
6664
parameters:
6765
- $ref: '#/components/parameters/AcceptEncodingHeader'
6866
- in: query
@@ -164,7 +162,7 @@ paths:
164162
summary: Create Document
165163
description: Creates a document with the given ID and contents.
166164
tags:
167-
- Single Document Operations
165+
- Basic Document Operations
168166
parameters:
169167
- $ref: '#/components/parameters/ContentEncodingHeader'
170168
- $ref: '#/components/parameters/ExpiresHeader'
@@ -207,7 +205,7 @@ paths:
207205
summary: Update Document
208206
description: Updates the specified document with the given contents.
209207
tags:
210-
- Single Document Operations
208+
- Basic Document Operations
211209
parameters:
212210
- $ref: '#/components/parameters/ContentEncodingHeader'
213211
- $ref: '#/components/parameters/IfMatchHeader'
@@ -251,7 +249,7 @@ paths:
251249
summary: Delete Document
252250
description: Deletes the specified document.
253251
tags:
254-
- Single Document Operations
252+
- Basic Document Operations
255253
parameters:
256254
- $ref: '#/components/parameters/IfMatchHeader'
257255
- $ref: '#/components/parameters/DurabilityLevelHeader'
@@ -284,7 +282,7 @@ paths:
284282
summary: Check Alpha API
285283
description: Checks whether the alpha API is enabled.
286284
tags:
287-
- Tools
285+
- Health Check
288286
responses:
289287
'200':
290288
description: The alpha API is enabled
@@ -666,9 +664,11 @@ paths:
666664
post:
667665
operationId: touchDocument
668666
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).
670670
tags:
671-
- Expiry Operations
671+
- Basic Document Operations
672672
parameters:
673673
- $ref: '#/components/parameters/AcceptEncodingHeader'
674674
requestBody:

0 commit comments

Comments
 (0)