Skip to content

Commit cfbd9aa

Browse files
authored
fix(specs): normalize spelling of summaries (#5340)
1 parent c8eb245 commit cfbd9aa

File tree

4 files changed

+12
-8
lines changed

4 files changed

+12
-8
lines changed

specs/ingestion/paths/sources/validate.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
post:
22
tags:
33
- sources
4-
summary: Validates a source payload
4+
summary: Validate a source payload
55
description: |
66
Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
77
operationId: validateSource

specs/ingestion/paths/sources/validateID.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
post:
22
tags:
33
- sources
4-
summary: Validates an update of a source payload
4+
summary: Validate an update of a source payload
55
description: |
66
Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
77
operationId: validateSourceBeforeUpdate

specs/ingestion/paths/tasks/v2/pushTask.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
post:
22
tags:
33
- tasks
4-
summary: Push records by taskID
4+
summary: Push records by task ID
55
description: >
6-
Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter,
7-
for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task.
6+
Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter,
7+
for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task.
88
9-
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.
9+
If you want to transform your data before indexing, this is the recommended way of ingesting your records.
1010
1111
This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
1212
operationId: pushTask
13+
externalDocs:
14+
url: https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/
15+
description: |
16+
Related guide: Pre-indexing data transformation.
1317
x-acl:
1418
- addObject
1519
- deleteIndex

specs/ingestion/paths/tasks/v2/taskID.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ get:
2323
put:
2424
tags:
2525
- tasks
26-
summary: Fully updates a task
26+
summary: Fully update a task
2727
description: Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
2828
operationId: replaceTask
2929
parameters:
@@ -48,7 +48,7 @@ put:
4848
patch:
4949
tags:
5050
- tasks
51-
summary: Partially updates a task
51+
summary: Partially update a task
5252
description: Partially updates a task by its ID.
5353
operationId: updateTask
5454
parameters:

0 commit comments

Comments
 (0)