Browse Source

[doc] /config/{last_update,mac_address}

Maxime Alves LIRMM@home 3 years ago
parent
commit
efe7c4383d
1 changed files with 51 additions and 0 deletions
  1. 51
    0
      docs/openapi.yaml

+ 51
- 0
docs/openapi.yaml View File

@@ -62,6 +62,57 @@ paths:
62 62
                 '415':
63 63
                     description: Sent data cannot be treated
64 64
 
65
+    /config/mac_address:
66
+        get:
67
+            operation: get_mac_address
68
+            summary: Retrieves current mac address (in the configuration)
69
+            responses:
70
+                '200':
71
+                    description: The mac address value
72
+                    content:
73
+                        text/plain:
74
+                            examples: 00:11:22:33:44:55
75
+        post:
76
+            operation: set_mac_address
77
+            summary: Sets current mac address (in the configuration)
78
+            content:
79
+                text/plain:
80
+                    description: If empty, sets to machine current mac
81
+                    examples:
82
+                        ff:ee:dd:cc:bb:aa
83
+            responses:
84
+                '200':
85
+                    description: The mac address value
86
+                    content:
87
+                        examples: 00:11:22:33:44:55
88
+
89
+    /config/last_update:
90
+        get:
91
+            operation: get_last_update
92
+            summary: Retrieves heatpump.last_update current value (in the configuration)
93
+            responses:
94
+                '200':
95
+                    description: The last update timestamp 
96
+                    content:
97
+                        text/plain:
98
+                            examples: 00:11:22:33:44:55
99
+        post:
100
+            operation: set_last_update
101
+            summary: Sets heatpump.last_update value (in the configuration)
102
+            content:
103
+                text/plain:
104
+                    description: If 0, sets to current time
105
+                        If < 0, sets to +x seconds
106
+                        If > 0, sets to -x seconds
107
+                    examples:
108
+                        0
109
+            responses:
110
+                '200':
111
+                    description: The last_update timestamp
112
+                    content:
113
+                        examples: 1600205650
114
+
115
+
65 116
     /variable_types:
66 117
         get:
67 118
             operation: get_variable_types

Loading…
Cancel
Save