From efe7c4383dcb6dcb3958668366664cc6dc74a537 Mon Sep 17 00:00:00 2001 From: "Maxime Alves LIRMM@home" Date: Tue, 15 Sep 2020 23:49:54 +0200 Subject: [PATCH] [doc] /config/{last_update,mac_address} --- docs/openapi.yaml | 51 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/docs/openapi.yaml b/docs/openapi.yaml index 61a7a97..390dff7 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -62,6 +62,57 @@ paths: '415': description: Sent data cannot be treated + /config/mac_address: + get: + operation: get_mac_address + summary: Retrieves current mac address (in the configuration) + responses: + '200': + description: The mac address value + content: + text/plain: + examples: 00:11:22:33:44:55 + post: + operation: set_mac_address + summary: Sets current mac address (in the configuration) + content: + text/plain: + description: If empty, sets to machine current mac + examples: + ff:ee:dd:cc:bb:aa + responses: + '200': + description: The mac address value + content: + examples: 00:11:22:33:44:55 + + /config/last_update: + get: + operation: get_last_update + summary: Retrieves heatpump.last_update current value (in the configuration) + responses: + '200': + description: The last update timestamp + content: + text/plain: + examples: 00:11:22:33:44:55 + post: + operation: set_last_update + summary: Sets heatpump.last_update value (in the configuration) + content: + text/plain: + description: If 0, sets to current time + If < 0, sets to +x seconds + If > 0, sets to -x seconds + examples: + 0 + responses: + '200': + description: The last_update timestamp + content: + examples: 1600205650 + + /variable_types: get: operation: get_variable_types