-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Description
Background
SDK state machine JSON definitions include documentation fields that OttoChain's strict decoder rejects. The _ prefix is reserved for fiber engine processing, so we need a different approach.
Proposal
Add an optional comment field to StateMachineDefinition (and possibly other schema types):
case class StateMachineDefinition(
states: Map[StateId, State],
initialState: StateId,
transitions: List[Transition],
metadata: Option[JsonLogicValue] = None,
comment: Option[String] = None // NEW: documentation field
)Alternatives Considered
_comment- Conflicts with reserved key convention (_prefix = engine processing)- Lenient decoding - Would silently ignore typos, prefer explicit fields
- Strip in SDK - Current workaround (PR feat(validation): reject reserved JSON Logic operators as field names #14), but loses documentation
Acceptance Criteria
- Add
comment: Option[String]toStateMachineDefinition - Consider adding to
StateandTransitionas well - Update SDK to use
commentinstead of_comment
Related
- SDK PR feat(validation): reject reserved JSON Logic operators as field names #14: temporary fix removing
initialDataTemplateand_commentfields - Reserved keys:
ReservedKeys.scala
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels