Skip to content

Commit 4c8fc8f

Browse files
committed
fix(specs): summary for saveObject/addOrUpdate methods
1 parent 9c4959e commit 4c8fc8f

File tree

2 files changed

+3
-5
lines changed

2 files changed

+3
-5
lines changed

specs/search/paths/objects/object.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ get:
4343
$ref: '../../../common/responses/MethodNotAllowed.yml'
4444
'404':
4545
$ref: '../../../common/responses/IndexNotFound.yml'
46-
4746
put:
4847
tags:
4948
- Records
@@ -55,6 +54,7 @@ put:
5554
If a record with the specified object ID exists, the existing record is replaced.
5655
Otherwise, a new record is added to the index.
5756
57+
If you want to use auto-generated object IDs, use the [`saveObject` operation](#tag/Records/operation/saveObject).
5858
To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead.
5959
To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
6060
parameters:
@@ -78,7 +78,6 @@ put:
7878
$ref: '../../../common/responses/MethodNotAllowed.yml'
7979
'404':
8080
$ref: '../../../common/responses/IndexNotFound.yml'
81-
8281
delete:
8382
tags:
8483
- Records
@@ -91,7 +90,6 @@ delete:
9190
9291
To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch).
9392
To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).
94-
9593
parameters:
9694
- $ref: '../../../common/parameters.yml#/IndexName'
9795
- $ref: '../../../common/parameters.yml#/ObjectID'

specs/search/paths/objects/objects.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ post:
55
x-acl:
66
- addObject
77
description: |
8-
Adds a record to an index or replace it.
8+
Adds a record to an index or replaces it.
99
1010
- If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index.
1111
- If a record with the specified object ID exists, the existing record is replaced.
@@ -16,7 +16,7 @@ post:
1616
To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
1717
1818
This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
19-
summary: Add or replace a record
19+
summary: Add a new record (with auto-generated object ID)
2020
parameters:
2121
- $ref: '../../../common/parameters.yml#/IndexName'
2222
requestBody:

0 commit comments

Comments
 (0)