diff --git a/static/rest-api.yaml b/static/rest-api.yaml index 6cc30c065..384ae6793 100644 --- a/static/rest-api.yaml +++ b/static/rest-api.yaml @@ -109,8 +109,9 @@ paths: post: summary: Control battery-discharge description: > - Prevent home battery discharge during vehicle fast charging. [Read - more.](https://docs.evcc.io/en/docs/features/battery) + Prevent home battery discharge during vehicle fast charging. + externalDocs: + url: https://docs.evcc.io/en/docs/features/battery tags: - Home Battery parameters: @@ -122,8 +123,9 @@ paths: delete: summary: Remove battery grid charge limit description: > - Remove battery grid charge limit. [Read - more.](https://docs.evcc.io/en/docs/features/battery) + Remove battery grid charge limit. + externalDocs: + url: https://docs.evcc.io/en/docs/features/battery tags: - Home Battery responses: @@ -138,8 +140,8 @@ paths: Uses price if a dynamic tariff exists. Uses emissions if a CO₂-tariff is configured. Ignored otherwise. - - [Read more.](https://docs.evcc.io/en/docs/features/battery) + externalDocs: + url: https://docs.evcc.io/en/docs/features/battery tags: - Home Battery parameters: @@ -175,7 +177,9 @@ paths: post: summary: Set battery buffer SoC description: | - Set battery buffer SoC. [Read more.](https://docs.evcc.io/en/docs/features/battery) + Set battery buffer SoC. + externalDocs: + url: https://docs.evcc.io/en/docs/features/battery tags: - Home Battery parameters: @@ -187,7 +191,9 @@ paths: post: summary: Set battery buffer start SoC description: | - Set battery buffer start SoC. [Read more.](https://docs.evcc.io/en/docs/features/battery) + Set battery buffer start SoC. + externalDocs: + url: https://docs.evcc.io/en/docs/features/battery tags: - Home Battery parameters: @@ -213,8 +219,9 @@ paths: post: summary: Set battery boost description: > - Enables or disables battery boost. [Read - more.](https://docs.evcc.io/en/docs/features/battery#battery-boost) + Enables or disables battery boost. + externalDocs: + url: https://docs.evcc.io/en/docs/features/battery#battery-boost tags: - Loadpoints parameters: @@ -227,8 +234,9 @@ paths: post: summary: Disable threshold-delay description: > - Specifies the delay before charging stops in solar mode. [Read - more.](https://docs.evcc.io/en/docs/reference/configuration/loadpoints) + Specifies the delay before charging stops in solar mode. + externalDocs: + url: https://docs.evcc.io/en/docs/reference/configuration/loadpoints tags: - Loadpoints parameters: @@ -241,8 +249,9 @@ paths: post: summary: Disable threshold description: > - Specifies the grid draw power to stop charging in solar mode. [Read - more.](https://docs.evcc.io/en/docs/reference/configuration/loadpoints#threshold-1) + Specifies the grid draw power to stop charging in solar mode. + externalDocs: + url: https://docs.evcc.io/en/docs/reference/configuration/loadpoints#threshold-1 tags: - Loadpoints parameters: @@ -255,8 +264,9 @@ paths: post: summary: Enable threshold-delay description: > - Specifies the delay before charging starts in solar mode. [Read - more.](https://docs.evcc.io/en/docs/reference/configuration/loadpoints#delay) + Specifies the delay before charging starts in solar mode. + externalDocs: + url: https://docs.evcc.io/en/docs/reference/configuration/loadpoints#delay tags: - Loadpoints parameters: @@ -270,7 +280,8 @@ paths: summary: Enable threshold description: > Specifies the available surplus power to start charging in solar mode. - [Read more.](https://docs.evcc.io/en/docs/reference/configuration/loadpoints#threshold) + externalDocs: + url: https://docs.evcc.io/en/docs/reference/configuration/loadpoints#threshold tags: - Loadpoints parameters: @@ -285,7 +296,9 @@ paths: description: > Updates the energy limit of the loadpoint. Only available for guest vehicles and vehicles with unknown SoC. Limit is removed on vehicle - disconnect. [Read more.](https://docs.evcc.io/en/docs/features/limit) + disconnect. + externalDocs: + url: https://docs.evcc.io/en/docs/features/limit tags: - Loadpoints parameters: @@ -299,8 +312,9 @@ paths: summary: Update limit SoC description: > Updates the SoC limit of the loadpoint. Requires a connected vehicle - with known SoC. Limit is maintained across charging sessions. [Read - more.](https://docs.evcc.io/en/docs/features/limit) + with known SoC. Limit is maintained across charging sessions. + externalDocs: + url: https://docs.evcc.io/en/docs/features/limit tags: - Loadpoints parameters: @@ -339,8 +353,9 @@ paths: post: summary: Update charge mode description: > - Changes the charging behavior of the loadpoint. [Read - more.](https://docs.evcc.io/en/docs/features/solar-charging) + Changes the charging behavior of the loadpoint. + externalDocs: + url: https://docs.evcc.io/en/docs/features/solar-charging tags: - Loadpoints parameters: @@ -363,8 +378,9 @@ paths: Updates the allowed phases of the loadpoint. Selects the desired phase mode for chargers with automatic phase switching. For manual phase switching chargers (via cable or Lasttrennschalter) this value tells - evcc the actual phases. [Read - more.](https://docs.evcc.io/en/docs/reference/configuration/loadpoints#phases) + evcc the actual phases. + externalDocs: + url: https://docs.evcc.io/en/docs/reference/configuration/loadpoints#phases tags: - Loadpoints parameters: @@ -382,8 +398,9 @@ paths: get: summary: Plan rates description: > - Returns the current charging plan for this loadpoint. [Read - more.](https://docs.evcc.io/en/docs/features/plans) + Returns the current charging plan for this loadpoint. + externalDocs: + url: https://docs.evcc.io/en/docs/features/plans tags: - Loadpoints parameters: @@ -410,7 +427,9 @@ paths: summary: Deletes the energy-based charging plan description: > Deletes the charging plan. Only available when a vehicle with unknown - SoC is connected. [Read more.](https://docs.evcc.io/en/docs/features/plans) + SoC is connected. + externalDocs: + url: https://docs.evcc.io/en/docs/features/plans tags: - Loadpoints parameters: @@ -423,8 +442,9 @@ paths: summary: Sets an energy-based charging plan description: > Creates a charging plan with fixed time and energy target. Only - available when a vehicle with unknown SoC is connected. [Read - more.](https://docs.evcc.io/en/docs/features/plans) + available when a vehicle with unknown SoC is connected. + externalDocs: + url: https://docs.evcc.io/en/docs/features/plans tags: - Loadpoints parameters: @@ -446,7 +466,9 @@ paths: summary: Repeating plan preview description: > Simulates a repeating charging plan and returns the result. Does not - alter the actual charging plan. [Read more.](https://docs.evcc.io/en/docs/features/plans) + alter the actual charging plan. + externalDocs: + url: https://docs.evcc.io/en/docs/features/plans tags: - Loadpoints parameters: @@ -463,7 +485,9 @@ paths: summary: Preview of a charging plan description: > Simulates a charging plan and returns the result. Does not alter the - actual charging plan. [Read more.](https://docs.evcc.io/en/docs/features/plans) + actual charging plan. + externalDocs: + url: https://docs.evcc.io/en/docs/features/plans tags: - Loadpoints parameters: @@ -500,8 +524,9 @@ paths: post: summary: Set priority description: > - Sets the priority of the loadpoint. [Read - more.](https://docs.evcc.io/en/docs/reference/configuration/loadpoints#priority) + Sets the priority of the loadpoint. + externalDocs: + url: https://docs.evcc.io/en/docs/reference/configuration/loadpoints#priority tags: - Loadpoints parameters: @@ -522,7 +547,8 @@ paths: summary: Remove smart charging cost limit description: > Removes the price or emission limit for fast-charging with grid energy. - [Read more.](https://docs.evcc.io/en/docs/features/dynamic-prices) + externalDocs: + url: https://docs.evcc.io/en/docs/features/dynamic-prices tags: - Loadpoints parameters: @@ -535,7 +561,8 @@ paths: summary: Set smart charging cost limit description: > Sets the price or emission limit for fast-charging with grid energy. - [Read more.](https://docs.evcc.io/en/docs/features/dynamic-prices) + externalDocs: + url: https://docs.evcc.io/en/docs/features/dynamic-prices tags: - Loadpoints parameters: @@ -549,7 +576,9 @@ paths: summary: Delete vehicle description: > Removes the association of a vehicle to the loadpoint. Connected vehicle - is treated as guest vehicle. [Read more.](https://docs.evcc.io/en/docs/features/vehicle) + is treated as guest vehicle. + externalDocs: + url: https://docs.evcc.io/en/docs/features/vehicle tags: - Loadpoints parameters: @@ -560,8 +589,9 @@ paths: patch: summary: Start vehicle detection description: > - Starts the automaticvehicle detection process. [Read - more.](https://docs.evcc.io/en/docs/features/vehicle) + Starts the automaticvehicle detection process. + externalDocs: + url: https://docs.evcc.io/en/docs/features/vehicle tags: - Loadpoints parameters: @@ -573,8 +603,9 @@ paths: post: summary: Assign vehicle description: > - Changes the association of a vehicle to the loadpoint. [Read - more.](https://docs.evcc.io/en/docs/features/vehicle) + Changes the association of a vehicle to the loadpoint. + externalDocs: + url: https://docs.evcc.io/en/docs/features/vehicle tags: - Loadpoints parameters: @@ -597,7 +628,9 @@ paths: post: summary: Set battery priority SoC description: | - Set battery priority SoC. [Read more.](https://docs.evcc.io/en/docs/features/battery) + Set battery priority SoC. + externalDocs: + url: https://docs.evcc.io/en/docs/features/battery tags: - Home Battery parameters: @@ -609,8 +642,9 @@ paths: post: summary: Set grid residual power description: > - Sets target operating point of the control loop. [Read - more.](https://docs.evcc.io/en/docs/reference/configuration/site#residualpower) + Sets target operating point of the control loop. + externalDocs: + url: https://docs.evcc.io/en/docs/reference/configuration/site#residualpower tags: - Home Battery parameters: @@ -624,8 +658,9 @@ paths: put: summary: Update vehicle of charging session description: > - Update vehicle of charging session. [Read - more.](https://docs.evcc.io/en/docs/features/sessions) + Update vehicle of charging session. + externalDocs: + url: https://docs.evcc.io/en/docs/features/sessions tags: - Sessions requestBody: @@ -645,7 +680,9 @@ paths: delete: summary: Delete charging session description: | - Delete charging session. [Read more.](https://docs.evcc.io/en/docs/features/sessions) + Delete charging session. + externalDocs: + url: https://docs.evcc.io/en/docs/features/sessions tags: - Sessions responses: @@ -655,8 +692,9 @@ paths: get: summary: Charging sessions description: > - Returns a list of charging sessions. [Read - more.](https://docs.evcc.io/en/docs/features/sessions) + Returns a list of charging sessions. + externalDocs: + url: https://docs.evcc.io/en/docs/features/sessions tags: - Sessions parameters: @@ -706,8 +744,9 @@ paths: get: summary: Telemetry status description: > - Returns the current telemetry status. [Read - more.](https://docs.evcc.io/en/docs/reference/configuration/telemetry) + Returns the current telemetry status. + externalDocs: + url: https://docs.evcc.io/en/docs/reference/configuration/telemetry tags: - System responses: @@ -718,8 +757,9 @@ paths: summary: Enable/disable telemetry description: > Enable or disable telemetry. Note: Telemetry requires - [sponsorship](https://docs.evcc.io/en/docs/sponsorship). [Read - more.](https://docs.evcc.io/en/docs/reference/configuration/telemetry) + sponsorship. + externalDocs: + url: https://docs.evcc.io/en/docs/reference/configuration/telemetry tags: - System parameters: @@ -759,8 +799,9 @@ paths: description: > Returns the complete state of the system. This structure is used by the UI. It can be filtered by [JQ](https://jqlang.github.io/jq/) to only - return a subset of the data. [Read - more.](https://docs.evcc.io/en/docs/reference/configuration/state) + return a subset of the data. + externalDocs: + url: https://docs.evcc.io/en/docs/reference/configuration/state tags: - General parameters: @@ -790,8 +831,9 @@ paths: get: summary: Logs description: > - Returns the latest log lines. [Read - more.](https://docs.evcc.io/en/docs/reference/configuration/log) + Returns the latest log lines. + externalDocs: + url: https://docs.evcc.io/en/docs/reference/configuration/log security: - cookieAuth: [] tags: @@ -834,9 +876,10 @@ paths: /system/log/areas: get: summary: List of all log areas - description: | - Returns a list of all log areas (e.g. `lp-1`, `site`, `db`). - security: + description: > + Tariff information. Returns the prices or emission values for the upcoming hours + externalDocs: + url: https://docs.evcc.io/en/docs/devices/tariffs - cookieAuth: [] tags: - System @@ -908,8 +951,9 @@ paths: post: summary: Set SoC limit description: > - Charging will stop when this SoC is reached. [Read - more.](https://docs.evcc.io/en/docs/features/limits) + Charging will stop when this SoC is reached. + externalDocs: + url: https://docs.evcc.io/en/docs/features/limits tags: - Vehicles parameters: @@ -922,8 +966,9 @@ paths: post: summary: Set minimum SoC description: > - Vehicle will be fast-charged until this SoC is reached. [Read - more.](https://docs.evcc.io/en/docs/features/limits) + Vehicle will be fast-charged until this SoC is reached. + externalDocs: + url: https://docs.evcc.io/en/docs/features/limits tags: - Vehicles parameters: @@ -936,8 +981,9 @@ paths: post: summary: Update repeating plans description: > - Updates the repeating charging plan. [Read - more.](https://docs.evcc.io/en/docs/features/plans) + Updates the repeating charging plan. + externalDocs: + url: https://docs.evcc.io/en/docs/features/plans tags: - Vehicles parameters: @@ -962,7 +1008,9 @@ paths: delete: summary: Delete a SoC-based charging plan description: | - Deletes the charging plan [Read more.](https://docs.evcc.io/en/docs/features/plans) + Deletes the charging plan + externalDocs: + url: https://docs.evcc.io/en/docs/features/plans tags: - Vehicles parameters: @@ -974,8 +1022,9 @@ paths: post: summary: Set a SoC-based charging plan description: > - Creates a charging plan with fixed time and SoC target. [Read - more.](https://docs.evcc.io/en/docs/features/plans) + Creates a charging plan with fixed time and SoC target. + externalDocs: + url: https://docs.evcc.io/en/docs/features/plans tags: - Vehicles parameters: