Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic record doc support #94

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

BeRT2me
Copy link

@BeRT2me BeRT2me commented Aug 28, 2023

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 BeRT2me closed this Aug 28, 2023
@BeRT2me BeRT2me reopened this Aug 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant