pydantic-avro icon indicating copy to clipboard operation
pydantic-avro copied to clipboard

Add basic record doc support

Open BeRT2me opened this issue 1 year ago • 0 comments

This allows two different scenarios to work:

  1. Pydantic Models with docstrings have their docstring converted to an Avro record doc.
  2. Avro records with doc get added as Pydantic Models' docstring.

Aka:

class Test(AvroBase):
    """docstring"""
    c1: int

Becomes

{
    "type": "record",
    "namespace": "Test"
    "name": "Test",
    "doc": "docstring",
    "fields": [{"type": "int", "name": "c1"}]
}

And visa-versa.

BeRT2me avatar Aug 28 '23 19:08 BeRT2me