Skip to content

Commit 5a5d97f

Browse files
author
nik
committed
Update KeyIndicators component
1 parent 4ab7349 commit 5a5d97f

File tree

1 file changed

+18
-26
lines changed

1 file changed

+18
-26
lines changed

fern/openapi/resources/dashboards.yaml

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -7,46 +7,38 @@ components:
77
type: object
88
properties:
99
key:
10-
title: The key for this KPI, where you can find the value from inside main_kpi
10+
title: Indicator key
11+
description: The key for this KPI, where you can find the value from inside main_kpi
1112
type: string
1213
title:
13-
title: The title for this metric, to be displayed to the user
14+
title: Metric title
15+
description: The title for this metric, to be displayed to the user
1416
type: string
1517
main_kpi:
1618
title: The primary KPI, displayed in the top left of the box
17-
type: object
18-
properties:
19-
title:
20-
title: The name of this indicator
21-
type: string
22-
values:
23-
title: The numerical values to fill in for this KPI
24-
type: object
25-
properties:
26-
accuracy:
27-
title: The number correct over the number predicted
28-
type: number
29-
num_successful_predictions:
30-
title: The number of predictions which have a successful prediction (as opposed to an error)
31-
type: integer
32-
num_correct_predictions:
33-
title: The number of predictions that were correct (compared to ground truth)
34-
type: integer
19+
type: string
20+
secondary_kpi:
21+
title: The secondary KPI, displayed in the top right of the box
22+
type: string
3523
additional_kpis:
36-
title: Secondary KPIs, displayed below the main_kpi
24+
title: Additional KPIs
25+
type: array
26+
items:
27+
type: object
28+
extra_kpis:
29+
title: Extra KPIs
3730
type: array
3831
items:
3932
type: object
4033
properties:
4134
key:
42-
title: The key where the value for this metric can be found (from the main kpi's payload)
35+
title: Indicator key
36+
description: The key for this KPI, where you can find the value from inside main_kpi
4337
type: string
4438
label:
45-
title: The name to print on the screen, describing this additional KPI
39+
title: Label
40+
description: The label for this KPI, to be displayed to the user
4641
type: string
47-
extra_kpis:
48-
title: Secondary KPIs, displayed to the right of the main_kpi
49-
type: array
5042

5143
KeyIndicatorValue:
5244
title: Key Indicator Value

0 commit comments

Comments
 (0)