Skip to content

Commit 45cf975

Browse files
committed
chore: better descriptions
1 parent 37c33aa commit 45cf975

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

specs/ingestion/paths/push.yml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
post:
2-
summary: Push a `batch` request payload through the Pipeline
3-
description: Push a `batch` request payload through the Pipeline. You can check the status of your request with the observability endpoints.
2+
summary: Pushes records through the Pipeline, directly to an index
3+
description: >
4+
Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter,
5+
for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task.
6+
7+
This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found,
8+
an error will be returned.
49
operationId: push
510
x-acl:
611
- addObject
@@ -14,7 +19,6 @@ post:
1419
- $ref: '../../common/parameters.yml#/IndexName'
1520
- $ref: '../common/parameters.yml#/watch'
1621
requestBody:
17-
description: Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
1822
content:
1923
application/json:
2024
schema:

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
post:
22
tags:
33
- tasks
4-
summary: Push a `batch` request payload through the Pipeline
5-
description: Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
4+
summary: Pushes records through the Pipeline, directly to an index
5+
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.
8+
9+
This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
610
operationId: pushTask
711
x-acl:
812
- addObject
@@ -16,7 +20,6 @@ post:
1620
- $ref: '../../../common/parameters.yml#/pathTaskID'
1721
- $ref: '../../../common/parameters.yml#/watch'
1822
requestBody:
19-
description: Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
2023
content:
2124
application/json:
2225
schema:

0 commit comments

Comments
 (0)