wip: rest-api.yaml

evcc-io · Jan 3, 2025 · ffee2e2 · ffee2e2
1 parent 632dfd5
commit ffee2e2
Showing 1 changed file with 177 additions and 2 deletions.
diff --git a/static/rest-api.yaml b/static/rest-api.yaml
@@ -381,7 +381,7 @@ paths:
       responses:
         200:
           $ref: "#/components/responses/NumberResult"
-  /loadpoints/{id}/limitenery/{power}:
+  /loadpoints/{id}/limitenergy/{power}:
     post:
       summary: Limit energy
       description: TODO
@@ -593,6 +593,140 @@ paths:
       responses:
         200:
           $ref: "#/components/responses/EmptyResult"
+  /loadpoints/{id}/remotedemand/{demand}/{source}:
+    post:
+      summary: TODO
+      description: TODO
+      tags:
+        - Loadpoints
+      parameters:
+        - $ref: "#/components/parameters/id"
+        - name: demand
+          in: path
+          required: true
+          schema:
+            $ref: "#/components/schemas/Demand"
+        - name: source
+          in: path
+          required: true
+          schema:
+            $ref: "#/components/schemas/Source"
+      responses:
+        200:
+          description: TODO
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  result:
+                    type: object
+                    properties:
+                      demand:
+                        $ref: "#/components/schemas/Demand"
+                      source:
+                        $ref: "#/components/schemas/Source"
+  /loadpoints/{id}/enable/threshold/{threshold}:
+    post:
+      summary: TODO
+      description: TODO
+      tags:
+        - Loadpoints
+      parameters:
+        - $ref: "#/components/parameters/id"
+        - $ref: "#/components/parameters/threshold"
+      responses:
+        200:
+          $ref: "#/components/responses/NumberResult"
+  /loadpoints/{id}/enable/delay/{delay}:
+    post:
+      summary: TODO
+      description: TODO
+      tags:
+        - Loadpoints
+      parameters:
+        - $ref: "#/components/parameters/id"
+        - $ref: "#/components/parameters/delay"
+      responses:
+        200:
+          $ref: "#/components/responses/IntegerResult"
+  /loadpoints/{id}/disble/threshold/{threshold}:
+    post:
+      summary: TODO
+      description: TODO
+      tags:
+        - Loadpoints
+      parameters:
+        - $ref: "#/components/parameters/id"
+        - $ref: "#/components/parameters/threshold"
+      responses:
+        200:
+          $ref: "#/components/responses/NumberResult"
+  /loadpoints/{id}/disable/delay/{delay}:
+    post:
+      summary: TODO
+      description: TODO
+      tags:
+        - Loadpoints
+      parameters:
+        - $ref: "#/components/parameters/id"
+        - $ref: "#/components/parameters/delay"
+      responses:
+        200:
+          $ref: "#/components/responses/IntegerResult"
+  /loadpoints/{id}/smartcostlimit/{cost}:
+    post:
+      summary: Set smart charging cost limit
+      description: TODO
+      tags:
+        - Loadpoints
+      parameters:
+        - $ref: "#/components/parameters/id"
+        - $ref: "#/components/parameters/cost"
+      responses:
+        200:
+          $ref: "#/components/responses/NumberResult"
+  /loadpoints/{id}/smartcostlimit:
+    delete:
+      summary: Remove smart charging cost limit
+      description: TODO
+      tags:
+        - Loadpoints
+      parameters:
+        - $ref: "#/components/parameters/id"
+      responses:
+        200:
+          description: "TODO"
+  /loadpoints/{id}/priority/{priority}:
+    post:
+      summary: Set priority
+      description: TODO
+      tags:
+        - Loadpoints
+      parameters:
+        - $ref: "#/components/parameters/id"
+        - name: priority
+          in: path
+          description: TODO
+          required: true
+          schema:
+            type: integer
+            minimum: 0
+      responses:
+        200:
+          $ref: "#/components/responses/IntegerResult"
+  /loadpoints/{id}/batteryboost/{enable}:
+    post:
+      summary: Set battery boost
+      description: TODO
+      tags:
+        - Loadpoints
+      parameters:
+        - $ref: "#/components/parameters/id"
+        - $ref: "#/components/parameters/enable"
+      responses:
+        200:
+          $ref: "#/components/responses/BooleanResult"
 #   _______               _____             __ _
 #  |__   __|         _   / ____|           / _(_)
 #     | | __ _  __ _(_) | |     ___  _ __ | |_ _  __ _
@@ -604,6 +738,17 @@ paths:
 
 components:
   schemas:
+    Source:
+      description: TODO
+      type: string
+      pattern: "[0-9a-zA-Z_-]+"
+    Demand:
+      description: TODO
+      type: string
+      enum:
+        - " "
+        - hard
+        - soft
     Mode:
       description: TODO
       type: string
@@ -629,6 +774,10 @@ components:
       description: The ID. Starts with 1.
       type: integer
       minimum: 1
+    Delay:
+      description: TODO
+      type: integer
+      minimum: 0
     Soc:
       description: Soc in %
       type: number
@@ -647,6 +796,9 @@ components:
       description: Power in Watt
       type: number
       minimum: 0
+    Threshold:
+      description: TODO Power in Watt
+      type: number
     StaticPlan:
       description: TODO
       type: object
@@ -730,6 +882,13 @@ components:
       required: true
       schema:
         $ref: "#/components/schemas/Id"
+    delay:
+      name: id
+      in: path
+      description: TODO
+      required: true
+      schema:
+        $ref: "#/components/schemas/Delay"
     mode:
       name: mode
       in: path
@@ -748,7 +907,7 @@ components:
           - type: string
           - type: number
         enum:
-          ["true", "false", 1, 0, t, f, T, F, "TRUE", "FALSE", "True", "False"]
+          ["true", "false", 1, 0,]
     soc:
       name: soc
       in: path
@@ -789,6 +948,12 @@ components:
       required: true
       schema:
         $ref: "#/components/schemas/Power"
+    threshold:
+      name: power
+      in: path
+      required: true
+      schema:
+        $ref: "#/components/schemas/Threshold"
   responses:
     NumberResult:
       description: TODO
@@ -800,6 +965,16 @@ components:
               result:
                 description: TODO
                 type: number
+    IntegerResult:
+      description: TODO
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              result:
+                description: TODO
+                type: integer
     PlanRatesResult:
       description: TODO
       content: