Skip to content

Commit f135e97

Browse files
committed
fixes
1 parent eb05025 commit f135e97

File tree

4 files changed

+27
-15
lines changed

4 files changed

+27
-15
lines changed

specs/ingestion/common/schemas/common.yml

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,23 @@ updatedAt:
66
type: string
77
description: Date of last update (RFC3339 format).
88

9+
startedAt:
10+
type: string
11+
description: Date of start (RFC3339 format).
12+
13+
finishedAt:
14+
type: string
15+
description: Date of finish (RFC3339 format).
16+
17+
publishedAt:
18+
type: string
19+
description: Date of publish (RFC3339 format).
20+
921
DeleteResponse:
1022
type: object
1123
properties:
1224
deletedAt:
1325
type: string
14-
description: Date of deletion (RFC3339 format)
26+
description: Date of deletion (RFC3339 format).
1527
required:
1628
- deletedAt

specs/ingestion/paths/runs/events/eventID.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ get:
55
description: Get an event in a specific run.
66
operationId: getEvent
77
parameters:
8-
- $ref: '../../common/parameters.yml#/runID'
9-
- $ref: '../../common/parameters.yml#/eventID'
8+
- $ref: '../../../common/parameters.yml#/runID'
9+
- $ref: '../../../common/parameters.yml#/eventID'
1010
responses:
1111
'200':
1212
description: OK
1313
content:
1414
application/json:
1515
schema:
16-
$ref: '../../common/schemas/event.yml#/Event'
16+
$ref: '../../../common/schemas/event.yml#/Event'
1717
'400':
18-
$ref: '../../../common/responses/BadRequest.yml'
18+
$ref: '../../../../common/responses/BadRequest.yml'

specs/ingestion/paths/runs/events/events.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ get:
55
description: Get a list of events for a specific run.
66
operationId: getEvents
77
parameters:
8-
- $ref: '../../common/parameters.yml#/runID'
9-
- $ref: '../../common/parameters.yml#/itemsPerPage'
10-
- $ref: '../../common/parameters.yml#/page'
8+
- $ref: '../../../common/parameters.yml#/runID'
9+
- $ref: '../../../common/parameters.yml#/itemsPerPage'
10+
- $ref: '../../../common/parameters.yml#/page'
1111
responses:
1212
'200':
1313
description: OK
@@ -21,11 +21,11 @@ get:
2121
events:
2222
type: array
2323
items:
24-
$ref: '../../common/schemas/event.yml#/Event'
24+
$ref: '../../../common/schemas/event.yml#/Event'
2525
pagination:
26-
$ref: '../../common/schemas/pagination.yml#/Pagination'
26+
$ref: '../../../common/schemas/pagination.yml#/Pagination'
2727
required:
2828
- events
2929
- pagination
3030
'400':
31-
$ref: '../../../common/responses/BadRequest.yml'
31+
$ref: '../../../../common/responses/BadRequest.yml'

specs/ingestion/spec.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.2
22
info:
33
title: Ingestion API
4-
description: API powering the Data Ingestion feature of Algolia
4+
description: API powering the Data Ingestion feature of Algolia.
55
version: '1.0'
66
components:
77
securitySchemes:
@@ -26,15 +26,15 @@ tags:
2626
- name: destinations
2727
x-displayName: Destinations
2828
description: Destinations refers to an Algolia product (Search, Insight, Recommend, ...).
29+
- name: observability
30+
x-displayName: Observability
31+
description: Observability api tracks each runs and events.
2932
- name: sources
3033
x-displayName: Sources
3134
description: Sources describe the platform informations.
3235
- name: tasks
3336
x-displayName: Tasks
3437
description: Tasks refers to all type of Ingestion we can do (Reindex, On demand update, ...).
35-
- name: observability
36-
x-displayName: Observability
37-
description: Observability api tracks each runs and events
3838
paths:
3939
# authentications api
4040
/1/authentications:

0 commit comments

Comments
 (0)