@@ -5395,6 +5395,8 @@ components:
53955395 format: double
53965396 type: number
53975397 description: A mapping of threshold `timeframe` to the remaining error budget.
5398+ example:
5399+ 7d: 100.0
53985400 type: object
53995401 SLOErrorTimeframe:
54005402 description: 'The timeframe of the threshold associated with this error
@@ -5427,6 +5429,7 @@ components:
54275429 type: integer
54285430 message:
54295431 description: Optional message if there are specific query issues/warnings.
5432+ example: ''
54305433 type: string
54315434 numerator:
54325435 $ref: '#/components/schemas/SLOHistoryMetricsSeries'
@@ -5563,6 +5566,7 @@ components:
55635566 properties:
55645567 from_ts:
55655568 description: The `from` timestamp in epoch seconds.
5569+ example: 1615323990
55665570 format: int64
55675571 type: integer
55685572 group_by:
@@ -5571,6 +5575,7 @@ components:
55715575
55725576
55735577 This is not included in responses for `monitor` based SLOs.'
5578+ example: []
55745579 items:
55755580 description: A grouping parameter.
55765581 type: string
@@ -5581,6 +5586,7 @@ components:
55815586
55825587
55835588 This is not included in the responses for `metric` based SLOs.'
5589+ example: []
55845590 items:
55855591 $ref: '#/components/schemas/SLOHistorySLIData'
55865592 type: array
@@ -5590,6 +5596,7 @@ components:
55905596
55915597
55925598 This is not included in the responses for `metric` based SLOs.'
5599+ example: []
55935600 items:
55945601 $ref: '#/components/schemas/SLOHistorySLIData'
55955602 type: array
@@ -5601,9 +5608,11 @@ components:
56015608 additionalProperties:
56025609 $ref: '#/components/schemas/SLOThreshold'
56035610 description: mapping of string timeframe to the SLO threshold.
5611+ example: {}
56045612 type: object
56055613 to_ts:
56065614 description: The `to` timestamp in epoch seconds.
5615+ example: 1615928790
56075616 format: int64
56085617 type: integer
56095618 type:
@@ -5637,20 +5646,28 @@ components:
56375646 errors:
56385647 description: A list of errors while querying the history data for the service
56395648 level objective.
5649+ example: []
56405650 items:
56415651 $ref: '#/components/schemas/SLOHistoryResponseError'
56425652 type: array
56435653 group:
56445654 description: For groups in a grouped SLO, this is the group name.
5655+ example: name
56455656 type: string
56465657 history:
56475658 description: For `monitor` based SLOs, this includes the aggregated history
56485659 uptime time series.
56495660 items:
56505661 description: Represents an array time series data.
5662+ example:
5663+ - - 1579212382
5664+ - 0
56515665 items:
56525666 description: A time series data point which is a tuple of (timestamp,
56535667 value).
5668+ example:
5669+ - 1579212382
5670+ - 0
56545671 format: double
56555672 type: number
56565673 maxItems: 2
@@ -5660,14 +5677,17 @@ components:
56605677 monitor_modified:
56615678 description: For `monitor` based SLOs, this is the last modified timestamp
56625679 in epoch seconds of the monitor.
5680+ example: 1615867200
56635681 format: int64
56645682 type: integer
56655683 monitor_type:
56665684 description: For `monitor` based SLOs, this describes the type of monitor.
5685+ example: string
56675686 type: string
56685687 name:
56695688 description: For groups in a grouped SLO, this is the group name. For monitors
56705689 in a multi-monitor SLO, this is the monitor name.
5690+ example: string
56715691 type: string
56725692 precision:
56735693 additionalProperties:
@@ -5676,12 +5696,16 @@ components:
56765696 type: number
56775697 description: A mapping of threshold `timeframe` to number of accurate decimals,
56785698 regardless of the from && to timestamp.
5699+ example:
5700+ 30d: 1
5701+ 7d: 2
56795702 type: object
56805703 preview:
56815704 description: 'For `monitor` based SLOs, when `true` this indicates that
56825705 a replay is in progress to give an accurate uptime
56835706
56845707 calculation.'
5708+ example: true
56855709 type: boolean
56865710 sli_value:
56875711 description: The current SLI value of the SLO over the history window.
@@ -5691,11 +5715,13 @@ components:
56915715 span_precision:
56925716 description: The amount of decimal places the SLI value is accurate to for
56935717 the given from `&&` to timestamp.
5718+ example: 2
56945719 format: double
56955720 type: number
56965721 uptime:
56975722 deprecated: true
56985723 description: Use `sli_value` instead.
5724+ example: 99.99
56995725 format: double
57005726 type: number
57015727 type: object
@@ -5742,7 +5768,7 @@ components:
57425768 corresponding
57435769
57445770 timeframe.'
5745- example: 0.0
5771+ example: 99.9
57465772 format: double
57475773 type: number
57485774 target_display:
@@ -5760,6 +5786,7 @@ components:
57605786 $ref: '#/components/schemas/SLOTimeframe'
57615787 warning:
57625788 description: The warning value for the service level objective.
5789+ example: 90.0
57635790 format: double
57645791 type: number
57655792 warning_display:
@@ -5772,6 +5799,7 @@ components:
57725799 Included in service level objective responses if a warning target exists.
57735800
57745801 Ignored in create/update requests.'
5802+ example: '90.0'
57755803 type: string
57765804 required:
57775805 - timeframe
@@ -5793,6 +5821,7 @@ components:
57935821 enum:
57945822 - metric
57955823 - monitor
5824+ example: metric
57965825 type: string
57975826 x-enum-varnames:
57985827 - METRIC
0 commit comments