Skip to content

Commit 2e9503b

Browse files
committed
introduce recent API changes into public API specification
1 parent f0c247f commit 2e9503b

File tree

1 file changed

+47
-31
lines changed

1 file changed

+47
-31
lines changed

api-docs/openapi_backend_publicapi_v1.yaml

Lines changed: 47 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ components:
33
AggregateDiagnosticsV4:
44
type: object
55
properties:
6-
totalRowsTested:
6+
datasetRowsTested:
77
type: integer
88
format: int32
99
required:
10-
- totalRowsTested
10+
- datasetRowsTested
1111
AgreementSlimDTO:
1212
type: object
1313
properties:
@@ -24,7 +24,7 @@ components:
2424
duplicate:
2525
type: object
2626
$ref: '#/components/schemas/DuplicateDiagnosticsV4'
27-
failedRows:
27+
failed_rows:
2828
type: object
2929
$ref: '#/components/schemas/FailedRowsDiagnosticsV4'
3030
freshness:
@@ -38,8 +38,8 @@ components:
3838
$ref: '#/components/schemas/MetricDiagnosticsV4'
3939
missing:
4040
type: object
41-
$ref: '#/components/schemas/MissingCheckResultDiagnosticsV4'
42-
rowCount:
41+
$ref: '#/components/schemas/MissingDiagnosticsV4'
42+
row_count:
4343
type: object
4444
$ref: '#/components/schemas/RowCountDiagnosticsV4'
4545
schema:
@@ -415,6 +415,12 @@ components:
415415
DuplicateDiagnosticsV4:
416416
type: object
417417
properties:
418+
checkRowsTested:
419+
type: integer
420+
format: int32
421+
datasetRowsTested:
422+
type: integer
423+
format: int32
418424
failedRowsCount:
419425
type: integer
420426
format: int32
@@ -426,13 +432,11 @@ components:
426432
type: number
427433
failedRowsSourceQuery:
428434
type: string
429-
totalRowsTested:
430-
type: integer
431-
format: int32
432435
required:
436+
- checkRowsTested
437+
- datasetRowsTested
433438
- failedRowsCount
434439
- failedRowsPercent
435-
- totalRowsTested
436440
ErrorResponse:
437441
type: object
438442
properties:
@@ -463,6 +467,9 @@ components:
463467
FailedRowsDiagnosticsV4:
464468
type: object
465469
properties:
470+
datasetRowsTested:
471+
type: integer
472+
format: int32
466473
failedRowsCount:
467474
type: integer
468475
format: int32
@@ -474,33 +481,28 @@ components:
474481
type: number
475482
failedRowsSourceQuery:
476483
type: string
477-
totalRowsTested:
478-
type: integer
479-
format: int32
480484
required:
485+
- datasetRowsTested
481486
- failedRowsCount
482487
- failedRowsPercent
483-
- totalRowsTested
484488
FreshnessDiagnosticsV4:
485489
type: object
486490
properties:
487491
actualTimestamp:
488492
type: string
489493
actualTimestampUtc:
490494
type: string
495+
datasetRowsTested:
496+
type: integer
497+
format: int32
491498
expectedTimestamp:
492499
type: string
493500
expectedTimestampUtc:
494501
type: string
495-
totalRowsTested:
496-
type: integer
497-
format: int32
498502
required:
499-
- actualTimestamp
500-
- actualTimestampUtc
503+
- datasetRowsTested
501504
- expectedTimestamp
502505
- expectedTimestampUtc
503-
- totalRowsTested
504506
HistogramBinContentDTO:
505507
type: object
506508
properties:
@@ -576,6 +578,12 @@ components:
576578
InvalidDiagnosticsV4:
577579
type: object
578580
properties:
581+
checkRowsTested:
582+
type: integer
583+
format: int32
584+
datasetRowsTested:
585+
type: integer
586+
format: int32
579587
failedRowsCount:
580588
type: integer
581589
format: int32
@@ -587,13 +595,11 @@ components:
587595
type: number
588596
failedRowsSourceQuery:
589597
type: string
590-
totalRowsTested:
591-
type: integer
592-
format: int32
593598
required:
599+
- checkRowsTested
600+
- datasetRowsTested
594601
- failedRowsCount
595602
- failedRowsPercent
596-
- totalRowsTested
597603
LogLevelDTO:
598604
type: string
599605
enum:
@@ -632,12 +638,20 @@ components:
632638
MetricDiagnosticsV4:
633639
type: object
634640
properties:
635-
totalRowsTested:
641+
datasetRowsTested:
636642
type: integer
637643
format: int32
638-
MissingCheckResultDiagnosticsV4:
644+
required:
645+
- datasetRowsTested
646+
MissingDiagnosticsV4:
639647
type: object
640648
properties:
649+
checkRowsTested:
650+
type: integer
651+
format: int32
652+
datasetRowsTested:
653+
type: integer
654+
format: int32
641655
failedRowsCount:
642656
type: integer
643657
format: int32
@@ -649,13 +663,11 @@ components:
649663
type: number
650664
failedRowsSourceQuery:
651665
type: string
652-
totalRowsTested:
653-
type: integer
654-
format: int32
655666
required:
667+
- checkRowsTested
668+
- datasetRowsTested
656669
- failedRowsCount
657670
- failedRowsPercent
658-
- totalRowsTested
659671
OwnerDTO:
660672
type: object
661673
properties:
@@ -1098,11 +1110,15 @@ components:
10981110
RowCountDiagnosticsV4:
10991111
type: object
11001112
properties:
1101-
totalRowsTested:
1113+
checkRowsTested:
1114+
type: integer
1115+
format: int32
1116+
datasetRowsTested:
11021117
type: integer
11031118
format: int32
11041119
required:
1105-
- totalRowsTested
1120+
- checkRowsTested
1121+
- datasetRowsTested
11061122
ScanStateDTO:
11071123
type: string
11081124
enum:

0 commit comments

Comments
 (0)