You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
After #203 is completed, then each specified annotation may be implemented for each of the supported codecs for which it makes sense to support the annotation.
This ticket is to implement the @fieldNameAliases annotation. This annotation, which may be applied to any field, contains a list of aliases the field is sometimes known by, which is a hint to the deserialization for different protocols to check for the field not only under its primary name, but also under its alternate names.
For example, maybe it may be the case that the id of Order is usually stored in a field id, but occassionally appears under order_id. Adding this annotation is a hint to the deserialization process to try not just id, but also, order_id.
The main place where this new annotation should be used is in the different protocols that ZIO Schema supports. For example, the zio-schema-json protocol, which has serialization / deserialization in the JSON protocol.
ZIO Schema already captures annotations, so it is only necessary to look at the annotations and ensure that serialization / deserialization respects them in every protocol where the annotation makes sense.
The text was updated successfully, but these errors were encountered:
After #203 is completed, then each specified annotation may be implemented for each of the supported codecs for which it makes sense to support the annotation.
This ticket is to implement the
@fieldNameAliases
annotation. This annotation, which may be applied to any field, contains a list of aliases the field is sometimes known by, which is a hint to the deserialization for different protocols to check for the field not only under its primary name, but also under its alternate names.For example, maybe it may be the case that the
id
ofOrder
is usually stored in a fieldid
, but occassionally appears underorder_id
. Adding this annotation is a hint to the deserialization process to try not justid
, but also,order_id
.The main place where this new annotation should be used is in the different protocols that ZIO Schema supports. For example, the
zio-schema-json
protocol, which has serialization / deserialization in the JSON protocol.ZIO Schema already captures annotations, so it is only necessary to look at the annotations and ensure that serialization / deserialization respects them in every protocol where the annotation makes sense.
The text was updated successfully, but these errors were encountered: