Skip to content

Commit 4db9834

Browse files
committed
Update OpenAPI spec evcc-io/evcc@7cc9adc
1 parent 726b5e1 commit 4db9834

File tree

1 file changed

+131
-13
lines changed

1 file changed

+131
-13
lines changed

static/openapi.yaml

Lines changed: 131 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -398,8 +398,6 @@ paths:
398398
properties:
399399
planId:
400400
$ref: "#/components/schemas/Id"
401-
precondition:
402-
$ref: "#/components/schemas/Precondition"
403401
- $ref: "#/components/schemas/PlanRates"
404402
/loadpoints/{id}/plan/energy:
405403
delete:
@@ -488,6 +486,33 @@ paths:
488486
responses:
489487
"200":
490488
$ref: "#/components/responses/PlanRatesResult"
489+
/loadpoints/{id}/plan/strategy:
490+
post:
491+
operationId: setLoadpointPlanStrategy
492+
summary: Set plan strategy
493+
description: "Updates the charging plan strategy for the loadpoint."
494+
externalDocs:
495+
url: https://docs.evcc.io/en/docs/features/plans
496+
tags:
497+
- loadpoints
498+
parameters:
499+
- $ref: "#/components/parameters/id"
500+
requestBody:
501+
required: true
502+
content:
503+
application/json:
504+
schema:
505+
$ref: "#/components/schemas/PlanStrategy"
506+
responses:
507+
200:
508+
description: Success
509+
content:
510+
application/json:
511+
schema:
512+
type: object
513+
properties:
514+
result:
515+
$ref: "#/components/schemas/PlanStrategy"
491516
/loadpoints/{id}/priority/{priority}:
492517
post:
493518
operationId: setLoadpointPriority
@@ -702,6 +727,42 @@ paths:
702727
responses:
703728
"200":
704729
$ref: "#/components/responses/NullResult"
730+
/gridsessions:
731+
get:
732+
operationId: getGridSessions
733+
summary: Grid limitation sessions
734+
description: "Returns a list of HEMS grid limitation events."
735+
tags:
736+
- sessions
737+
parameters:
738+
- name: format
739+
in: query
740+
description: Response format (default json)
741+
schema:
742+
type: string
743+
enum:
744+
- csv
745+
- name: lang
746+
in: query
747+
description: Language (defaults to accept header)
748+
schema:
749+
type: string
750+
example: de
751+
responses:
752+
"200":
753+
description: Success
754+
content:
755+
application/json:
756+
schema:
757+
type: object
758+
properties:
759+
result:
760+
$ref: "#/components/schemas/GridSessions"
761+
text/csv:
762+
schema:
763+
description: Download csv-file
764+
type: string
765+
format: binary
705766
/sessions:
706767
get:
707768
operationId: getSessions
@@ -1044,10 +1105,6 @@ paths:
10441105
- $ref: "#/components/parameters/vehicleName"
10451106
- $ref: "#/components/parameters/soc"
10461107
- $ref: "#/components/parameters/timestamp"
1047-
- in: query
1048-
name: precondition
1049-
schema:
1050-
$ref: "#/components/schemas/Precondition"
10511108
responses:
10521109
"200":
10531110
description: Success
@@ -1057,7 +1114,39 @@ paths:
10571114
type: object
10581115
properties:
10591116
result:
1060-
$ref: "#/components/schemas/StaticSocPlan"
1117+
type: object
1118+
properties:
1119+
soc:
1120+
$ref: "#/components/schemas/Soc"
1121+
time:
1122+
$ref: "#/components/schemas/Timestamp"
1123+
/vehicles/{name}/plan/strategy:
1124+
post:
1125+
operationId: setVehiclePlanStrategy
1126+
summary: Set plan strategy
1127+
description: "Updates the charging plan strategy for the vehicle."
1128+
externalDocs:
1129+
url: https://docs.evcc.io/en/docs/features/plans
1130+
tags:
1131+
- vehicles
1132+
parameters:
1133+
- $ref: "#/components/parameters/vehicleName"
1134+
requestBody:
1135+
required: true
1136+
content:
1137+
application/json:
1138+
schema:
1139+
$ref: "#/components/schemas/PlanStrategy"
1140+
responses:
1141+
200:
1142+
description: Success
1143+
content:
1144+
application/json:
1145+
schema:
1146+
type: object
1147+
properties:
1148+
result:
1149+
$ref: "#/components/schemas/PlanStrategy"
10611150
components:
10621151
schemas:
10631152
BatteryMode:
@@ -1107,6 +1196,30 @@ components:
11071196
chargedEnergy:
11081197
type: number
11091198
description: Charged energy in kWh
1199+
GridSessions:
1200+
description: Grid limitation sessions
1201+
type: array
1202+
items:
1203+
type: object
1204+
properties:
1205+
id:
1206+
$ref: "#/components/schemas/Id"
1207+
created:
1208+
$ref: "#/components/schemas/Timestamp"
1209+
finished:
1210+
$ref: "#/components/schemas/Timestamp"
1211+
type:
1212+
type: string
1213+
enum:
1214+
- consumption
1215+
- feedin
1216+
description: Type of grid limitation event
1217+
gridPower:
1218+
type: number
1219+
description: Grid power in watts
1220+
limitPower:
1221+
type: number
1222+
description: Limitation power in watts
11101223
chargeDuration:
11111224
type: number
11121225
description: Duration of active charging
@@ -1244,6 +1357,17 @@ components:
12441357
type: array
12451358
items:
12461359
$ref: "#/components/schemas/Rate"
1360+
PlanStrategy:
1361+
description: Charging plan strategy configuration
1362+
type: object
1363+
properties:
1364+
continuous:
1365+
description: "Force continuous planning"
1366+
type: boolean
1367+
precondition:
1368+
description: "Precondition duration in seconds"
1369+
type: integer
1370+
minimum: 0
12471371
RepeatingPlan:
12481372
externalDocs:
12491373
url: https://docs.evcc.io/en/docs/features/plans#repeating-plans
@@ -1252,8 +1376,6 @@ components:
12521376
active:
12531377
description: "Set plan active."
12541378
type: boolean
1255-
precondition:
1256-
$ref: "#/components/schemas/Precondition"
12571379
soc:
12581380
$ref: "#/components/schemas/Soc"
12591381
time:
@@ -1278,17 +1400,13 @@ components:
12781400
properties:
12791401
energy:
12801402
$ref: "#/components/schemas/Energy"
1281-
precondition:
1282-
$ref: "#/components/schemas/Precondition"
12831403
time:
12841404
$ref: "#/components/schemas/Timestamp"
12851405
StaticSocPlan:
12861406
externalDocs:
12871407
url: https://docs.evcc.io/en/docs/features/plans#create-charging-plan
12881408
type: object
12891409
properties:
1290-
precondition:
1291-
$ref: "#/components/schemas/Precondition"
12921410
soc:
12931411
$ref: "#/components/schemas/Soc"
12941412
time:

0 commit comments

Comments
 (0)