Skip to content

Commit 3820402

Browse files
shortcutsshortcuts
committed
feat(specs): add v2 endpoints for ingestion
1 parent 0fa2673 commit 3820402

34 files changed

+302
-132
lines changed

‎clients/algoliasearch-client-ruby/lib/algolia/error.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ def initialize(message, errors = [])
1616
errors.last&.tap do |last_error|
1717
message += " Last error for #{last_error[:host]}: #{last_error[:error]}"
1818
end
19+
1920
super(message)
2021
@errors = errors
2122
end

‎clients/algoliasearch-client-ruby/lib/algolia/logger_helper.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ def self.create(debug_file = nil)
1111
begin
1212
file = File.new("debug.log", "a+")
1313
rescue Errno::EACCES, Errno::ENOENT => e
14-
puts "Failed to open debug.log: #{e.message}. Falling back to $stderr."
14+
puts("Failed to open debug.log: #{e.message}. Falling back to $stderr.")
1515
end
1616
end
1717

‎specs/ingestion/paths/tasks/v1/disableTask.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ put:
1010
- deleteIndex
1111
- editSettings
1212
parameters:
13-
- $ref: '../../common/parameters.yml#/pathTaskID'
13+
- $ref: '../../../common/parameters.yml#/pathTaskID'
1414
responses:
1515
'200':
1616
description: OK
1717
content:
1818
application/json:
1919
schema:
20-
$ref: '../../common/schemas/task.yml#/TaskUpdateResponse'
20+
$ref: '../../../common/schemas/task.yml#/TaskUpdateResponse'
2121
'400':
22-
$ref: '../../../common/responses/BadRequest.yml'
22+
$ref: '../../../../common/responses/BadRequest.yml'

‎specs/ingestion/paths/tasks/v1/enableTask.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ put:
99
- deleteIndex
1010
- editSettings
1111
parameters:
12-
- $ref: '../../common/parameters.yml#/pathTaskID'
12+
- $ref: '../../../common/parameters.yml#/pathTaskID'
1313
responses:
1414
'200':
1515
description: OK
1616
content:
1717
application/json:
1818
schema:
19-
$ref: '../../common/schemas/task.yml#/TaskUpdateResponse'
19+
$ref: '../../../common/schemas/task.yml#/TaskUpdateResponse'
2020
'400':
21-
$ref: '../../../common/responses/BadRequest.yml'
21+
$ref: '../../../../common/responses/BadRequest.yml'

‎specs/ingestion/paths/tasks/v1/runTask.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ post:
99
- deleteIndex
1010
- editSettings
1111
parameters:
12-
- $ref: '../../common/parameters.yml#/pathTaskID'
12+
- $ref: '../../../common/parameters.yml#/pathTaskID'
1313
responses:
1414
'200':
1515
description: OK
1616
content:
1717
application/json:
1818
schema:
19-
$ref: '../../common/schemas/run.yml#/RunResponse'
19+
$ref: '../../../common/schemas/run.yml#/RunResponse'
2020
'400':
21-
$ref: '../../../common/responses/BadRequest.yml'
21+
$ref: '../../../../common/responses/BadRequest.yml'

‎specs/ingestion/paths/tasks/v1/searchTasks.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ post:
1212
content:
1313
application/json:
1414
schema:
15-
$ref: '../../common/schemas/task.yml#/TaskSearch'
15+
$ref: '../../../common/schemas/task.yml#/TaskSearch'
1616
required: true
1717
responses:
1818
'200':
@@ -23,6 +23,6 @@ post:
2323
title: searchTasksResponse
2424
type: array
2525
items:
26-
$ref: '../../common/schemas/task.yml#/Task'
26+
$ref: '../../../common/schemas/task.yml#/TaskV1'
2727
'400':
28-
$ref: '../../../common/responses/BadRequest.yml'
28+
$ref: '../../../../common/responses/BadRequest.yml'

‎specs/ingestion/paths/tasks/v1/taskID.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ get:
99
- deleteIndex
1010
- editSettings
1111
parameters:
12-
- $ref: '../../common/parameters.yml#/pathTaskID'
12+
- $ref: '../../../common/parameters.yml#/pathTaskID'
1313
responses:
1414
'200':
1515
description: OK
1616
content:
1717
application/json:
1818
schema:
19-
$ref: '../../common/schemas/task.yml#/Task'
19+
$ref: '../../../common/schemas/task.yml#/TaskV1'
2020
'400':
21-
$ref: '../../../common/responses/BadRequest.yml'
21+
$ref: '../../../../common/responses/BadRequest.yml'
2222

2323
patch:
2424
tags:
@@ -27,22 +27,22 @@ patch:
2727
description: Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
2828
operationId: updateTaskV1
2929
parameters:
30-
- $ref: '../../common/parameters.yml#/pathTaskID'
30+
- $ref: '../../../common/parameters.yml#/pathTaskID'
3131
requestBody:
3232
content:
3333
application/json:
3434
schema:
35-
$ref: '../../common/schemas/task.yml#/TaskUpdate'
35+
$ref: '../../../common/schemas/task.yml#/TaskUpdateV1'
3636
required: true
3737
responses:
3838
'200':
3939
description: OK
4040
content:
4141
application/json:
4242
schema:
43-
$ref: '../../common/schemas/task.yml#/TaskUpdateResponse'
43+
$ref: '../../../common/schemas/task.yml#/TaskUpdateResponse'
4444
'400':
45-
$ref: '../../../common/responses/BadRequest.yml'
45+
$ref: '../../../../common/responses/BadRequest.yml'
4646

4747
delete:
4848
tags:
@@ -51,13 +51,13 @@ delete:
5151
description: Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
5252
operationId: deleteTaskV1
5353
parameters:
54-
- $ref: '../../common/parameters.yml#/pathTaskID'
54+
- $ref: '../../../common/parameters.yml#/pathTaskID'
5555
responses:
5656
'200':
5757
description: OK
5858
content:
5959
application/json:
6060
schema:
61-
$ref: '../../common/schemas/common.yml#/DeleteResponse'
61+
$ref: '../../../common/schemas/common.yml#/DeleteResponse'
6262
'400':
63-
$ref: '../../../common/responses/BadRequest.yml'
63+
$ref: '../../../../common/responses/BadRequest.yml'

‎specs/ingestion/paths/tasks/v1/tasks.yml

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ get:
99
- deleteIndex
1010
- editSettings
1111
parameters:
12-
- $ref: '../../common/parameters.yml#/itemsPerPage'
13-
- $ref: '../../common/parameters.yml#/page'
14-
- $ref: '../../common/taskParameters.yml#/action'
15-
- $ref: '../../common/taskParameters.yml#/enabled'
16-
- $ref: '../../common/taskParameters.yml#/sourceID'
17-
- $ref: '../../common/taskParameters.yml#/destinationID'
18-
- $ref: '../../common/taskParameters.yml#/triggerType'
19-
- $ref: '../../common/taskParameters.yml#/sort'
20-
- $ref: '../../common/parameters.yml#/order'
12+
- $ref: '../../../common/parameters.yml#/itemsPerPage'
13+
- $ref: '../../../common/parameters.yml#/page'
14+
- $ref: '../../../common/taskParameters.yml#/action'
15+
- $ref: '../../../common/taskParameters.yml#/enabled'
16+
- $ref: '../../../common/taskParameters.yml#/sourceID'
17+
- $ref: '../../../common/taskParameters.yml#/destinationID'
18+
- $ref: '../../../common/taskParameters.yml#/triggerType'
19+
- $ref: '../../../common/taskParameters.yml#/sort'
20+
- $ref: '../../../common/parameters.yml#/order'
2121
responses:
2222
'200':
2323
description: OK
@@ -32,14 +32,14 @@ get:
3232
tasks:
3333
type: array
3434
items:
35-
$ref: '../../common/schemas/task.yml#/Task'
35+
$ref: '../../../common/schemas/task.yml#/TaskV1'
3636
pagination:
37-
$ref: '../../common/schemas/pagination.yml#/Pagination'
37+
$ref: '../../../common/schemas/pagination.yml#/Pagination'
3838
required:
3939
- tasks
4040
- pagination
4141
'400':
42-
$ref: '../../../common/responses/BadRequest.yml'
42+
$ref: '../../../../common/responses/BadRequest.yml'
4343

4444
post:
4545
tags:
@@ -52,14 +52,14 @@ post:
5252
content:
5353
application/json:
5454
schema:
55-
$ref: '../../common/schemas/task.yml#/TaskCreate'
55+
$ref: '../../../common/schemas/task.yml#/TaskCreateV1'
5656
required: true
5757
responses:
5858
'200':
5959
description: OK
6060
content:
6161
application/json:
6262
schema:
63-
$ref: '../../common/schemas/task.yml#/TaskCreateResponse'
63+
$ref: '../../../common/schemas/task.yml#/TaskCreateResponse'
6464
'400':
65-
$ref: '../../../common/responses/BadRequest.yml'
65+
$ref: '../../../../common/responses/BadRequest.yml'

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ put:
99
- deleteIndex
1010
- editSettings
1111
parameters:
12-
- $ref: '../../common/parameters.yml#/pathTaskID'
12+
- $ref: '../../../common/parameters.yml#/pathTaskID'
1313
responses:
1414
'200':
1515
description: OK
1616
content:
1717
application/json:
1818
schema:
19-
$ref: '../../common/schemas/task.yml#/TaskUpdateResponse'
19+
$ref: '../../../common/schemas/task.yml#/TaskUpdateResponse'
2020
'400':
21-
$ref: '../../../common/responses/BadRequest.yml'
21+
$ref: '../../../../common/responses/BadRequest.yml'

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ put:
99
- deleteIndex
1010
- editSettings
1111
parameters:
12-
- $ref: '../../common/parameters.yml#/pathTaskID'
12+
- $ref: '../../../common/parameters.yml#/pathTaskID'
1313
responses:
1414
'200':
1515
description: OK
1616
content:
1717
application/json:
1818
schema:
19-
$ref: '../../common/schemas/task.yml#/TaskUpdateResponse'
19+
$ref: '../../../common/schemas/task.yml#/TaskUpdateResponse'
2020
'400':
21-
$ref: '../../../common/responses/BadRequest.yml'
21+
$ref: '../../../../common/responses/BadRequest.yml'

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ post:
99
- deleteIndex
1010
- editSettings
1111
parameters:
12-
- $ref: '../../common/parameters.yml#/pathTaskID'
12+
- $ref: '../../../common/parameters.yml#/pathTaskID'
1313
responses:
1414
'200':
1515
description: OK
1616
content:
1717
application/json:
1818
schema:
19-
$ref: '../../common/schemas/run.yml#/RunResponse'
19+
$ref: '../../../common/schemas/run.yml#/RunResponse'
2020
'400':
21-
$ref: '../../../common/responses/BadRequest.yml'
21+
$ref: '../../../../common/responses/BadRequest.yml'

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ post:
1212
content:
1313
application/json:
1414
schema:
15-
$ref: '../../common/schemas/task.yml#/TaskSearch'
15+
$ref: '../../../common/schemas/task.yml#/TaskSearch'
1616
required: true
1717
responses:
1818
'200':
@@ -23,6 +23,6 @@ post:
2323
title: searchTasksResponse
2424
type: array
2525
items:
26-
$ref: '../../common/schemas/task.yml#/Task'
26+
$ref: '../../../common/schemas/task.yml#/Task'
2727
'400':
28-
$ref: '../../../common/responses/BadRequest.yml'
28+
$ref: '../../../../common/responses/BadRequest.yml'

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ get:
99
- deleteIndex
1010
- editSettings
1111
parameters:
12-
- $ref: '../../common/parameters.yml#/pathTaskID'
12+
- $ref: '../../../common/parameters.yml#/pathTaskID'
1313
responses:
1414
'200':
1515
description: OK
1616
content:
1717
application/json:
1818
schema:
19-
$ref: '../../common/schemas/task.yml#/Task'
19+
$ref: '../../../common/schemas/task.yml#/Task'
2020
'400':
21-
$ref: '../../../common/responses/BadRequest.yml'
21+
$ref: '../../../../common/responses/BadRequest.yml'
2222

2323
patch:
2424
tags:
@@ -27,22 +27,22 @@ patch:
2727
description: Updates a task by its ID.
2828
operationId: updateTask
2929
parameters:
30-
- $ref: '../../common/parameters.yml#/pathTaskID'
30+
- $ref: '../../../common/parameters.yml#/pathTaskID'
3131
requestBody:
3232
content:
3333
application/json:
3434
schema:
35-
$ref: '../../common/schemas/task.yml#/TaskUpdate'
35+
$ref: '../../../common/schemas/task.yml#/TaskUpdate'
3636
required: true
3737
responses:
3838
'200':
3939
description: OK
4040
content:
4141
application/json:
4242
schema:
43-
$ref: '../../common/schemas/task.yml#/TaskUpdateResponse'
43+
$ref: '../../../common/schemas/task.yml#/TaskUpdateResponse'
4444
'400':
45-
$ref: '../../../common/responses/BadRequest.yml'
45+
$ref: '../../../../common/responses/BadRequest.yml'
4646

4747
delete:
4848
tags:
@@ -51,13 +51,13 @@ delete:
5151
description: Deletes a task by its ID.
5252
operationId: deleteTask
5353
parameters:
54-
- $ref: '../../common/parameters.yml#/pathTaskID'
54+
- $ref: '../../../common/parameters.yml#/pathTaskID'
5555
responses:
5656
'200':
5757
description: OK
5858
content:
5959
application/json:
6060
schema:
61-
$ref: '../../common/schemas/common.yml#/DeleteResponse'
61+
$ref: '../../../common/schemas/common.yml#/DeleteResponse'
6262
'400':
63-
$ref: '../../../common/responses/BadRequest.yml'
63+
$ref: '../../../../common/responses/BadRequest.yml'

0 commit comments

Comments
 (0)