Use as a library

[IvanJosipovic]

Hi team,

I'm working on library which generates C# Models and Assemblies from Kubernetes CRDs (Open API specs) and I find this library incredibly appealing.

I have tired to utilize Yardam as a library as I only need the model generation components with my own extensions. However, my attempts have been hampered by most of the classes being internal/private and the library being hardcoded for its current use cases.

This has caused me to fork the library to validate my use case, which I have done here https://github.com/IvanJosipovic/KubernetesCRDModelGen/tree/openapi/src

Due to the size of this library, I would prefer not to have to manage a fork, so I'm curios if the team is open to some PRs and/or suggestions how make its components more usable externally.

Thank you!

[brantburnett]

First of all, let me say I'm excited to see more people using the library, even as a fork. And yes, we are more than open to PRs and suggestions.

For simple changes, feel free to just directly create a PR. For more complex changes then I'd recommend opening an issue for discussion first. That way you won't spend a lot of time creating a PR just to have us come back with major design changes.

At a high level, let me go ahead and cover some of the design concepts with you. This may help with the discussion.

• We have intentionally left many APIs internal and not public as a design decision. The reason for this is that once it's public we're stuck with it long-term (unless we introduce breaking changes). Therefore we want the exposure of any API to be a very intentional design decision. There are almost certainly some internal APIs we want to make public once we understand the use case, but we want to give it careful thought. So please explain the use case well so we can all understand it.
• The design is also based on the concept of extensions. If you have specialized scenarios that don't broadly apply to all consumers, we'd want that to be supported by you creating an extension. Of course, this may mean exposing some APIs for your extension to use (as discussed above).

Thanks in advance, we appreciate any feedback or PRs that help us improve things.