Skip to content

Commit 3ec5f5f

Browse files
shortcutsshortcuts
authored
feat(specs): add v2 endpoints for ingestion (#3416)
1 parent 90762d1 commit 3ec5f5f

File tree

13 files changed

+156
-59
lines changed

13 files changed

+156
-59
lines changed

‎clients/algoliasearch-client-swift/Sources/Search/Extra/SearchClientExtension.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,7 @@ public extension SearchClient {
426426
func chunkedBatch(
427427
indexName: String,
428428
objects: [some Encodable],
429-
action: Action = .addObject,
429+
action: SearchAction = .addObject,
430430
waitForTasks: Bool = false,
431431
batchSize: Int = 1000,
432432
requestOptions: RequestOptions? = nil
@@ -439,7 +439,7 @@ public extension SearchClient {
439439
for batch in batches {
440440
let batchResponse = try await self.batch(
441441
indexName: indexName,
442-
batchWriteParams: BatchWriteParams(
442+
batchWriteParams: SearchBatchWriteParams(
443443
requests: batch.map {
444444
.init(action: action, body: AnyCodable($0))
445445
}

‎generators/src/main/java/com/algolia/codegen/AlgoliaSwiftGenerator.java

+3
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
public class AlgoliaSwiftGenerator extends Swift5ClientCodegen {
3333

3434
private static final List<String> reservedModelNames = List.of(
35+
"action",
3536
"advancedsyntaxfeatures",
3637
"alternativesasexact",
3738
"anchoring",
@@ -44,6 +45,8 @@ public class AlgoliaSwiftGenerator extends Swift5ClientCodegen {
4445
"basesearchparams",
4546
"basesearchparamswithoutquery",
4647
"basesearchresponse",
48+
"batchrequest",
49+
"batchwriteparams",
4750
"condition",
4851
"configuration",
4952
"consequence",

‎specs/common/schemas/Batch.yml

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
batchWriteParams:
2+
title: batchWriteParams
3+
description: Batch parameters.
4+
type: object
5+
additionalProperties: false
6+
properties:
7+
requests:
8+
type: array
9+
items:
10+
title: batchRequest
11+
type: object
12+
additionalProperties: false
13+
properties:
14+
action:
15+
$ref: '#/action'
16+
body:
17+
type: object
18+
description: Operation arguments (varies with specified `action`).
19+
example:
20+
name: Betty Jane McCamey
21+
company: Vita Foods Inc.
22+
email: betty@mccamey.com
23+
required:
24+
- action
25+
- body
26+
required:
27+
- requests
28+
example:
29+
batch:
30+
summary: Batch indexing request
31+
value:
32+
requests:
33+
- action: addObject
34+
body:
35+
name: Betty Jane McCamey
36+
company: Vita Foods Inc.
37+
email: betty@mccamey.com
38+
- action: addObject
39+
body:
40+
name: Gayla geimer
41+
company: Ortman McCain Co.
42+
email: gayla@geimer.com
43+
44+
action:
45+
type: string
46+
enum:
47+
- addObject
48+
- updateObject
49+
- partialUpdateObject
50+
- partialUpdateObjectNoCreate
51+
- deleteObject
52+
- delete
53+
- clear
54+
description: Type of indexing operation.

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

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
post:
2+
tags:
3+
- 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.
6+
operationId: pushTask
7+
x-acl:
8+
- addObject
9+
- deleteIndex
10+
- editSettings
11+
parameters:
12+
- $ref: '../../../common/parameters.yml#/pathTaskID'
13+
requestBody:
14+
description: Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
15+
content:
16+
application/json:
17+
schema:
18+
$ref: '../../../../common/schemas/Batch.yml#/batchWriteParams'
19+
required: true
20+
responses:
21+
'200':
22+
description: OK
23+
content:
24+
application/json:
25+
schema:
26+
$ref: '../../../common/schemas/run.yml#/RunResponse'
27+
'400':
28+
$ref: '../../../../common/responses/BadRequest.yml'

‎specs/ingestion/spec.yml

+2
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,8 @@ paths:
159159
$ref: 'paths/tasks/v2/taskID.yml'
160160
/2/tasks/{taskID}/run:
161161
$ref: 'paths/tasks/v2/runTask.yml'
162+
/2/tasks/{taskID}/push:
163+
$ref: 'paths/tasks/v2/pushTask.yml'
162164
/2/tasks/{taskID}/enable:
163165
$ref: 'paths/tasks/v2/enableTask.yml'
164166
/2/tasks/{taskID}/disable:

‎specs/search/helpers/chunkedBatch.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ method:
2727
description: The `batch` `action` to perform on the given array of `objects`, defaults to `addObject`.
2828
required: false
2929
schema:
30-
$ref: '../paths/objects/common/schemas.yml#/action'
30+
$ref: '../../common/schemas/Batch.yml#/action'
3131
- in: query
3232
name: waitForTasks
3333
description: Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.

‎specs/search/paths/objects/batch.yml

+3-43
Original file line numberDiff line numberDiff line change
@@ -12,53 +12,13 @@ post:
1212
- Actions are equivalent to the individual API requests of the same name.
1313
parameters:
1414
- $ref: '../../../common/parameters.yml#/IndexName'
15+
x-codegen-request-body-name: batchWriteParams
1516
requestBody:
16-
required: true
1717
content:
1818
application/json:
1919
schema:
20-
title: batchWriteParams
21-
description: Batch parameters.
22-
type: object
23-
additionalProperties: false
24-
properties:
25-
requests:
26-
type: array
27-
items:
28-
title: batchRequest
29-
type: object
30-
additionalProperties: false
31-
properties:
32-
action:
33-
$ref: 'common/schemas.yml#/action'
34-
body:
35-
type: object
36-
description: Operation arguments (varies with specified `action`).
37-
example:
38-
name: Betty Jane McCamey
39-
company: Vita Foods Inc.
40-
email: betty@mccamey.com
41-
42-
required:
43-
- action
44-
- body
45-
required:
46-
- requests
47-
examples:
48-
batch:
49-
summary: Batch indexing request
50-
value:
51-
requests:
52-
- action: addObject
53-
body:
54-
name: Betty Jane McCamey
55-
company: Vita Foods Inc.
56-
email: betty@mccamey.com
57-
- action: addObject
58-
body:
59-
name: Gayla geimer
60-
company: Ortman McCain Co.
61-
email: gayla@geimer.com
20+
$ref: '../../../common/schemas/Batch.yml#/batchWriteParams'
21+
required: true
6222
responses:
6323
'200':
6424
description: OK

‎specs/search/paths/objects/common/schemas.yml

-12
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,3 @@
1-
action:
2-
type: string
3-
enum:
4-
- addObject
5-
- updateObject
6-
- partialUpdateObject
7-
- partialUpdateObjectNoCreate
8-
- deleteObject
9-
- delete
10-
- clear
11-
description: Type of indexing operation.
12-
131
builtInOperationType:
142
type: string
153
enum:

‎specs/search/paths/objects/multipleBatch.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ post:
2626
additionalProperties: false
2727
properties:
2828
action:
29-
$ref: 'common/schemas.yml#/action'
29+
$ref: '../../../common/schemas/Batch.yml#/action'
3030
body:
3131
type: object
3232
description: Operation arguments (varies with specified `action`).

‎templates/csharp/snippets/method.mustache

+5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@ using Algolia.Search.Http;
44
using Algolia.Search.Clients;
55
// IMPORT<
66
using Algolia.Search.Models.{{clientPrefix}};
7+
{{#isSearchClient}}
78
using Action = Algolia.Search.Models.Search.Action;
9+
{{/isSearchClient}}
10+
{{^isSearchClient}}
11+
using Action = Algolia.Search.Models.Ingestion.Action;
12+
{{/isSearchClient}}
813

914
public class Snippet{{client}}
1015
{

‎templates/csharp/tests/e2e/e2e.mustache

+5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ using Xunit;
88
using System.Text.Json;
99
using Quibble.Xunit;
1010
using dotenv.net;
11+
{{#isSearchClient}}
1112
using Action = Algolia.Search.Models.Search.Action;
13+
{{/isSearchClient}}
14+
{{^isSearchClient}}
15+
using Action = Algolia.Search.Models.Ingestion.Action;
16+
{{/isSearchClient}}
1217

1318
namespace Algolia.Search.e2e;
1419

‎templates/csharp/tests/requests/requests.mustache

+5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ using Xunit;
88
using System.Text.Json;
99
using Quibble.Xunit;
1010
using dotenv.net;
11+
{{#isSearchClient}}
1112
using Action = Algolia.Search.Models.Search.Action;
13+
{{/isSearchClient}}
14+
{{^isSearchClient}}
15+
using Action = Algolia.Search.Models.Ingestion.Action;
16+
{{/isSearchClient}}
1217

1318
namespace Algolia.Search.requests;
1419

‎tests/CTS/requests/ingestion/pushTask.json

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
[
2+
{
3+
"parameters": {
4+
"taskID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
5+
"batchWriteParams": {
6+
"requests": [
7+
{
8+
"action": "addObject",
9+
"body": {
10+
"key": "bar",
11+
"foo": "1"
12+
}
13+
},
14+
{
15+
"action": "addObject",
16+
"body": {
17+
"key": "baz",
18+
"foo": "2"
19+
}
20+
}
21+
]
22+
}
23+
},
24+
"request": {
25+
"path": "/2/tasks/6c02aeb1-775e-418e-870b-1faccd4b2c0f/push",
26+
"method": "POST",
27+
"body": {
28+
"requests": [
29+
{
30+
"action": "addObject",
31+
"body": {
32+
"key": "bar",
33+
"foo": "1"
34+
}
35+
},
36+
{
37+
"action": "addObject",
38+
"body": {
39+
"key": "baz",
40+
"foo": "2"
41+
}
42+
}
43+
]
44+
}
45+
}
46+
}
47+
]

0 commit comments

Comments
 (0)