Skip to content

Commit a9599ec

Browse files
committed
various documentation improvements
1 parent 066b932 commit a9599ec

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

tado-openapispec-v2.yaml

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2740,8 +2740,9 @@ paths:
27402740
schema:
27412741
type: string
27422742
format: date
2743-
required: true
2743+
required: false
27442744
example: "2018-02-14"
2745+
description: current date is used when this query parameter is not provided
27452746
responses:
27462747
'200':
27472748
description: successful response
@@ -3391,6 +3392,7 @@ components:
33913392
33923393
33933394
known values:
3395+
33943396
* GW01 (Gateway V1)
33953397
33963398
* GW02 (Bridge V2)
@@ -3419,6 +3421,8 @@ components:
34193421
34203422
* VA02 (Smart Radiator Thermostat V3+)
34213423
3424+
* WR01 (Smart AC Control V3)
3425+
34223426
* WR02 (Smart AC Control V3+)
34233427
34243428
# EEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE
@@ -4087,7 +4091,7 @@ components:
40874091

40884092
PowerDataPoint:
40894093
type: object
4090-
description: Used in Weather and ZoneState, to expressAC power.
4094+
description: Used in ZoneState, to expressAC power.
40914095
properties:
40924096
type:
40934097
type: string
@@ -4118,10 +4122,10 @@ components:
41184122
properties:
41194123
timeSeriesType:
41204124
type: string
4121-
example: power
4125+
example: dataIntervals
41224126
valueType:
41234127
type: string
4124-
example: boolean
4128+
example: power
41254129
dataIntervals:
41264130
type: array
41274131
items:
@@ -4877,7 +4881,10 @@ components:
48774881
valueType:
48784882
type: string
48794883
example: heatingSetting
4880-
description: heatingSetting or airConditioningSetting
4884+
description: |
4885+
known values:
4886+
* heatingSetting
4887+
* airConditioningSetting
48814888
dataIntervals:
48824889
type: array
48834890
items:
@@ -4938,9 +4945,8 @@ components:
49384945
state:
49394946
type: string
49404947
example: ONLINE
4941-
description: >
4948+
description: |
49424949
known values:
4943-
49444950
* ONLINE
49454951
* OFFLINE
49464952
reason: # present when link.state is OFFLINE

0 commit comments

Comments
 (0)