Remove ChargingInstruction from ProvideChargingRequestsRequest#67
Remove ChargingInstruction from ProvideChargingRequestsRequest#67BenjaminKowatschVector wants to merge 1 commit intomainfrom
Conversation
Removed ChargingInstruction definition from schema.
There was a problem hiding this comment.
Pull request overview
This PR removes the ChargingInstruction field and its enum definition from the ProvideChargingRequestsRequest schema to address issue #40 regarding unclear usage of charging request deletion and the "TERMINATE" instruction. The repository contains JSON schema definitions for the VDV463 standard, which specifies an interface for EV charging management between presystems and load management systems.
Changes:
- Removed
ChargingInstructionenum definition with values "Normal", "Changed", and "Terminate" from schema definitions - Removed
chargingInstructionfield from theChargingRequestobject properties
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| }, | ||
| "chargingRequestData": { | ||
| "$ref": "#/definitions/ChargingRequestData" | ||
| }, |
There was a problem hiding this comment.
This removal constitutes a breaking change to the API schema. The schema is marked as "VDV463 1.0.0 FINAL" (line 4), yet a field is being removed from the ChargingRequest object. This could break existing implementations that:
- Send chargingInstruction in their requests
- Have code that depends on this field for indicating Normal/Changed/Terminate states
Consider whether:
- The version number should be incremented to reflect this breaking change
- A migration guide should be provided for implementations currently using this field
- The issue Beschreibung prüfen: Sind die Nutzung von dem Löschen und "TERMINATE" von Ladeanfragen eindeutig beschrieben? #40 mentions concerns about clarity of deletion and "TERMINATE" - ensure alternative mechanisms for terminating charging requests are clearly documented if chargingInstruction is removed
| }, | |
| }, | |
| "chargingInstruction": { | |
| "type": "string", | |
| "description": "DEPRECATED in favor of alternative mechanisms for indicating NORMAL / CHANGED / TERMINATE states. Retained in VDV463 1.0.0 FINAL for backward compatibility. Allowed values: Normal, Changed, Terminate.", | |
| "enum": [ | |
| "Normal", | |
| "Changed", | |
| "Terminate" | |
| ] | |
| }, |
Removed ChargingInstruction definition from schema.
Adresses Issue #40