Skip to content

fix(specs): different summaries for saveObject/addOrUpdate methods #4223

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
merged 2 commits into from
Dec 10, 2024
Merged

fix(specs): different summaries for saveObject/addOrUpdate methods #4223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c8fc8f
fix(specs): summary for saveObject/addOrUpdate methods
kai687 Dec 10, 2024
75bc3fd
fix: dont autoformat
kai687 Dec 10, 2024
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
1 change: 1 addition & 0 deletions specs/search/paths/objects/object.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ put:
If a record with the specified object ID exists, the existing record is replaced.
Otherwise, a new record is added to the index.

If you want to use auto-generated object IDs, use the [`saveObject` operation](#tag/Records/operation/saveObject).
To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead.
To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
parameters:
Expand Down
4 changes: 2 additions & 2 deletions specs/search/paths/objects/objects.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ post:
x-acl:
- addObject
description: |
Adds a record to an index or replace it.
Adds a record to an index or replaces it.

- If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index.
- If a record with the specified object ID exists, the existing record is replaced.
Expand All @@ -16,7 +16,7 @@ post:
To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).

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).
summary: Add or replace a record
summary: Add a new record (with auto-generated object ID)
parameters:
- $ref: '../../../common/parameters.yml#/IndexName'
requestBody:
Expand Down