Skip to content

Commit 2ed4963

Browse files
fix(specs): tag for push (#5029) (generated) [skip ci]
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
1 parent 33a1748 commit 2ed4963

File tree

3 files changed

+13
-16
lines changed

3 files changed

+13
-16
lines changed

docs/bundled/ingestion.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,10 @@
231231
},
232232
"/1/push/{indexName}": {
233233
"post": {
234-
"summary": "Pushes records to be transformed through the Pipeline, directly to an index",
234+
"tags": [
235+
"tasks"
236+
],
237+
"summary": "Pushes records to be transformed through the Pipeline, by indexName",
235238
"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.\nIf 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.\nThis method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.\n",
236239
"operationId": "push",
237240
"x-acl": [
@@ -1576,7 +1579,7 @@
15761579
"tags": [
15771580
"tasks"
15781581
],
1579-
"summary": "Pushes records to be transformed through the Pipeline, directly to an index",
1582+
"summary": "Pushes records to be transformed through the Pipeline, by taskID",
15801583
"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.\nIf 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.\nThis method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.\n",
15811584
"operationId": "pushTask",
15821585
"x-acl": [

docs/bundled/ingestion.yml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1029,9 +1029,9 @@ paths:
10291029
// >LOG
10301030
/1/push/{indexName}:
10311031
post:
1032-
summary: >-
1033-
Pushes records to be transformed through the Pipeline, directly to an
1034-
index
1032+
tags:
1033+
- tasks
1034+
summary: Pushes records to be transformed through the Pipeline, by indexName
10351035
description: >
10361036
Pushes records through the Pipeline, directly to an index. You can make
10371037
the call synchronous by providing the `watch` parameter, for
@@ -9179,9 +9179,7 @@ paths:
91799179
post:
91809180
tags:
91819181
- tasks
9182-
summary: >-
9183-
Pushes records to be transformed through the Pipeline, directly to an
9184-
index
9182+
summary: Pushes records to be transformed through the Pipeline, by taskID
91859183
description: >
91869184
Pushes records through the Pipeline, directly to an index. You can make
91879185
the call synchronous by providing the `watch` parameter, for

specs/bundled/ingestion.yml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -231,9 +231,9 @@ paths:
231231
- ingestion
232232
/1/push/{indexName}:
233233
post:
234-
summary: >-
235-
Pushes records to be transformed through the Pipeline, directly to an
236-
index
234+
tags:
235+
- ingestion
236+
summary: Pushes records to be transformed through the Pipeline, by indexName
237237
description: >
238238
Pushes records through the Pipeline, directly to an index. You can make
239239
the call synchronous by providing the `watch` parameter, for
@@ -283,8 +283,6 @@ paths:
283283
$ref: '#/components/schemas/WatchResponse'
284284
'400':
285285
$ref: '#/components/responses/BadRequest'
286-
tags:
287-
- ingestion
288286
/1/authentications:
289287
get:
290288
tags:
@@ -1113,9 +1111,7 @@ paths:
11131111
post:
11141112
tags:
11151113
- ingestion
1116-
summary: >-
1117-
Pushes records to be transformed through the Pipeline, directly to an
1118-
index
1114+
summary: Pushes records to be transformed through the Pipeline, by taskID
11191115
description: >
11201116
Pushes records through the Pipeline, directly to an index. You can make
11211117
the call synchronous by providing the `watch` parameter, for

0 commit comments

Comments
 (0)