Skip to content

fix(specs): normalize spelling of summaries #5340

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 1 commit into from
Sep 11, 2025
Merged

fix(specs): normalize spelling of summaries #5340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion specs/ingestion/paths/sources/validate.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
post:
tags:
- sources
summary: Validates a source payload
summary: Validate a source payload
description: |
Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
operationId: validateSource
Expand Down
2 changes: 1 addition & 1 deletion specs/ingestion/paths/sources/validateID.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
post:
tags:
- sources
summary: Validates an update of a source payload
summary: Validate an update of a source payload
description: |
Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
operationId: validateSourceBeforeUpdate
Expand Down
12 changes: 8 additions & 4 deletions specs/ingestion/paths/tasks/v2/pushTask.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
post:
tags:
- tasks
summary: Push records by taskID
summary: Push records by task ID
description: >
Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter,
for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task.
Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter,
for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task.

If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records.
If you want to transform your data before indexing, this is the recommended way of ingesting your records.

This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
operationId: pushTask
externalDocs:
url: https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/
description: |
Related guide: Pre-indexing data transformation.
x-acl:
- addObject
- deleteIndex
Expand Down
4 changes: 2 additions & 2 deletions specs/ingestion/paths/tasks/v2/taskID.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ get:
put:
tags:
- tasks
summary: Fully updates a task
summary: Fully update a task
description: Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
operationId: replaceTask
parameters:
Expand All @@ -48,7 +48,7 @@ put:
patch:
tags:
- tasks
summary: Partially updates a task
summary: Partially update a task
description: Partially updates a task by its ID.
operationId: updateTask
parameters:
Expand Down