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

Lack of documentation for CircularReferenceCounter #916

Open
maelick opened this issue Feb 26, 2024 · 0 comments
Open

Lack of documentation for CircularReferenceCounter #916

maelick opened this issue Feb 26, 2024 · 0 comments

Comments

@maelick
Copy link

maelick commented Feb 26, 2024

After updating a project with v0.114.0 to the latest, I had a rather complex specification that failed to load because of the default CircularReferenceCounter of 3.

Increasing the value to 42 fixed the issue but I had to dig through the changelog to figure out which change broke my code (it appears it's v0.115.0, most likely #768) and figure out the solution.

It would be nice to have some documentation for it, at least in the code/godoc of the variable, and ideally also in the README (under "Loading OpenAPI document"?)

I don't mind creating a PR for it, but I don't know myself what the variable exactly does, why it defaults to 3 and what are the consequences for increasing it.

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

No branches or pull requests

1 participant