Skip to content

Commit 80cc695

Browse files
committed
fix: WatchResponse
1 parent 566bddb commit 80cc695

File tree

8 files changed

+27
-30
lines changed

8 files changed

+27
-30
lines changed

specs/ingestion/common/schemas/common.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,3 +96,25 @@ Window:
9696
required:
9797
- startDate
9898
- endDate
99+
100+
WatchResponse:
101+
type: object
102+
additionalProperties: false
103+
properties:
104+
runID:
105+
$ref: './common.yml#/runID'
106+
data:
107+
type: array
108+
description: when used with discovering or validating sources, the sampled data of your source is returned.
109+
items:
110+
type: object
111+
events:
112+
description: in case of error, observability events will be added to the response, if any.
113+
type: array
114+
items:
115+
$ref: '../../common/schemas/event.yml#/Event'
116+
message:
117+
description: a message describing the outcome of a validate run.
118+
type: string
119+
required:
120+
- message

specs/ingestion/common/schemas/source.yml

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -476,28 +476,6 @@ sourceShopifyBase:
476476
x-discriminator-fields:
477477
- shopURL
478478

479-
SourceWatchResponse:
480-
type: object
481-
additionalProperties: false
482-
properties:
483-
runID:
484-
$ref: './common.yml#/runID'
485-
data:
486-
type: array
487-
description: depending on the source type, the validation returns sampling data of your source (JSON, CSV, BigQuery).
488-
items:
489-
type: object
490-
events:
491-
description: in case of error, observability events will be added to the response, if any.
492-
type: array
493-
items:
494-
$ref: '../../common/schemas/event.yml#/Event'
495-
message:
496-
description: a message describing the outcome of a validate run.
497-
type: string
498-
required:
499-
- message
500-
501479
RunSourcePayload:
502480
type: object
503481
additionalProperties: false

specs/ingestion/common/schemas/task.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -553,6 +553,3 @@ ShopifyMarket:
553553
- countries
554554
- currencies
555555
- locales
556-
557-
PushTaskResponse:
558-
$ref: './source.yml#/SourceWatchResponse'

specs/ingestion/paths/sources/discover.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ post:
1818
content:
1919
application/json:
2020
schema:
21-
$ref: '../../common/schemas/source.yml#/SourceWatchResponse'
21+
$ref: '../../common/schemas/common.yml#/WatchResponse'
2222
'400':
2323
$ref: '../../../common/responses/BadRequest.yml'

specs/ingestion/paths/sources/validate.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@ post:
2121
content:
2222
application/json:
2323
schema:
24-
$ref: '../../common/schemas/source.yml#/SourceWatchResponse'
24+
$ref: '../../common/schemas/common.yml#/WatchResponse'
2525
'400':
2626
$ref: '../../../common/responses/BadRequest.yml'

specs/ingestion/paths/sources/validateID.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,6 @@ post:
2323
content:
2424
application/json:
2525
schema:
26-
$ref: '../../common/schemas/source.yml#/SourceWatchResponse'
26+
$ref: '../../common/schemas/common.yml#/WatchResponse'
2727
'400':
2828
$ref: '../../../common/responses/BadRequest.yml'

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,6 @@ post:
4747
content:
4848
application/json:
4949
schema:
50-
$ref: '../../../common/schemas/task.yml#/PushTaskResponse'
50+
$ref: '../../../common/schemas/common.yml#/WatchResponse'
5151
'400':
5252
$ref: '../../../../common/responses/BadRequest.yml'

templates/java/guides/ingestion/pushSetup.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public class pushSetup {
1414
{{> snippets/init}}
1515

1616
// setting `watch` to `true` will make the call synchronous
17-
PushTaskResponse resp = {{#dynamicSnippet}}pushSetup{{/dynamicSnippet}};
17+
WatchResponse resp = {{#dynamicSnippet}}pushSetup{{/dynamicSnippet}};
1818

1919
System.out.println(resp);
2020

0 commit comments

Comments
 (0)