RuterNo / adt-doc

Documentation intended for PTOs who need to connect to Ruters digitale plattform
Apache License 2.0
4 stars 0 forks source link

Resolve #189: Update ADT 3.0 Telemetry Schema for Statically Typed Language Compatibility #190

Closed kalosar closed 9 months ago

kalosar commented 9 months ago

Resolves Issue #189 - Schema Incompatibility with Statically Typed Languages

Summary of the Problem: The existing Telemetry JSON schema's multi-typed value field is incompatible with Java code generators that require a single type per field, leading to code generation failures.

Proposed Changes: This PR redefines the value field in the schema to be of a generic object type, accommodating the static type constraints of languages like Java. The field's description is updated to reflect the expected types, guiding developers on the intended use.

Modifications Made:

Benefits of Change:

Updated Schema Details:


"value": {
  "description": "The value is expected to be a number, boolean, or string."
}