@@ -5395,6 +5395,8 @@ components:
5395
5395
format: double
5396
5396
type: number
5397
5397
description: A mapping of threshold `timeframe` to the remaining error budget.
5398
+ example:
5399
+ 7d: 100.0
5398
5400
type: object
5399
5401
SLOErrorTimeframe:
5400
5402
description: 'The timeframe of the threshold associated with this error
@@ -5427,6 +5429,7 @@ components:
5427
5429
type: integer
5428
5430
message:
5429
5431
description: Optional message if there are specific query issues/warnings.
5432
+ example: ''
5430
5433
type: string
5431
5434
numerator:
5432
5435
$ref: '#/components/schemas/SLOHistoryMetricsSeries'
@@ -5563,6 +5566,7 @@ components:
5563
5566
properties:
5564
5567
from_ts:
5565
5568
description: The `from` timestamp in epoch seconds.
5569
+ example: 1615323990
5566
5570
format: int64
5567
5571
type: integer
5568
5572
group_by:
@@ -5571,6 +5575,7 @@ components:
5571
5575
5572
5576
5573
5577
This is not included in responses for `monitor` based SLOs.'
5578
+ example: []
5574
5579
items:
5575
5580
description: A grouping parameter.
5576
5581
type: string
@@ -5581,6 +5586,7 @@ components:
5581
5586
5582
5587
5583
5588
This is not included in the responses for `metric` based SLOs.'
5589
+ example: []
5584
5590
items:
5585
5591
$ref: '#/components/schemas/SLOHistorySLIData'
5586
5592
type: array
@@ -5590,6 +5596,7 @@ components:
5590
5596
5591
5597
5592
5598
This is not included in the responses for `metric` based SLOs.'
5599
+ example: []
5593
5600
items:
5594
5601
$ref: '#/components/schemas/SLOHistorySLIData'
5595
5602
type: array
@@ -5601,9 +5608,11 @@ components:
5601
5608
additionalProperties:
5602
5609
$ref: '#/components/schemas/SLOThreshold'
5603
5610
description: mapping of string timeframe to the SLO threshold.
5611
+ example: {}
5604
5612
type: object
5605
5613
to_ts:
5606
5614
description: The `to` timestamp in epoch seconds.
5615
+ example: 1615928790
5607
5616
format: int64
5608
5617
type: integer
5609
5618
type:
@@ -5637,20 +5646,28 @@ components:
5637
5646
errors:
5638
5647
description: A list of errors while querying the history data for the service
5639
5648
level objective.
5649
+ example: []
5640
5650
items:
5641
5651
$ref: '#/components/schemas/SLOHistoryResponseError'
5642
5652
type: array
5643
5653
group:
5644
5654
description: For groups in a grouped SLO, this is the group name.
5655
+ example: name
5645
5656
type: string
5646
5657
history:
5647
5658
description: For `monitor` based SLOs, this includes the aggregated history
5648
5659
uptime time series.
5649
5660
items:
5650
5661
description: Represents an array time series data.
5662
+ example:
5663
+ - - 1579212382
5664
+ - 0
5651
5665
items:
5652
5666
description: A time series data point which is a tuple of (timestamp,
5653
5667
value).
5668
+ example:
5669
+ - 1579212382
5670
+ - 0
5654
5671
format: double
5655
5672
type: number
5656
5673
maxItems: 2
@@ -5660,14 +5677,17 @@ components:
5660
5677
monitor_modified:
5661
5678
description: For `monitor` based SLOs, this is the last modified timestamp
5662
5679
in epoch seconds of the monitor.
5680
+ example: 1615867200
5663
5681
format: int64
5664
5682
type: integer
5665
5683
monitor_type:
5666
5684
description: For `monitor` based SLOs, this describes the type of monitor.
5685
+ example: string
5667
5686
type: string
5668
5687
name:
5669
5688
description: For groups in a grouped SLO, this is the group name. For monitors
5670
5689
in a multi-monitor SLO, this is the monitor name.
5690
+ example: string
5671
5691
type: string
5672
5692
precision:
5673
5693
additionalProperties:
@@ -5676,12 +5696,16 @@ components:
5676
5696
type: number
5677
5697
description: A mapping of threshold `timeframe` to number of accurate decimals,
5678
5698
regardless of the from && to timestamp.
5699
+ example:
5700
+ 30d: 1
5701
+ 7d: 2
5679
5702
type: object
5680
5703
preview:
5681
5704
description: 'For `monitor` based SLOs, when `true` this indicates that
5682
5705
a replay is in progress to give an accurate uptime
5683
5706
5684
5707
calculation.'
5708
+ example: true
5685
5709
type: boolean
5686
5710
sli_value:
5687
5711
description: The current SLI value of the SLO over the history window.
@@ -5691,11 +5715,13 @@ components:
5691
5715
span_precision:
5692
5716
description: The amount of decimal places the SLI value is accurate to for
5693
5717
the given from `&&` to timestamp.
5718
+ example: 2
5694
5719
format: double
5695
5720
type: number
5696
5721
uptime:
5697
5722
deprecated: true
5698
5723
description: Use `sli_value` instead.
5724
+ example: 99.99
5699
5725
format: double
5700
5726
type: number
5701
5727
type: object
@@ -5742,7 +5768,7 @@ components:
5742
5768
corresponding
5743
5769
5744
5770
timeframe.'
5745
- example: 0.0
5771
+ example: 99.9
5746
5772
format: double
5747
5773
type: number
5748
5774
target_display:
@@ -5760,6 +5786,7 @@ components:
5760
5786
$ref: '#/components/schemas/SLOTimeframe'
5761
5787
warning:
5762
5788
description: The warning value for the service level objective.
5789
+ example: 90.0
5763
5790
format: double
5764
5791
type: number
5765
5792
warning_display:
@@ -5772,6 +5799,7 @@ components:
5772
5799
Included in service level objective responses if a warning target exists.
5773
5800
5774
5801
Ignored in create/update requests.'
5802
+ example: '90.0'
5775
5803
type: string
5776
5804
required:
5777
5805
- timeframe
@@ -5793,6 +5821,7 @@ components:
5793
5821
enum:
5794
5822
- metric
5795
5823
- monitor
5824
+ example: metric
5796
5825
type: string
5797
5826
x-enum-varnames:
5798
5827
- METRIC
0 commit comments