Giters

getkin / kin-openapi

OpenAPI 3.0 (and Swagger v2) implementation for Go (parsing, converting, validation, and more)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Lack of documentation for CircularReferenceCounter

maelick opened this issue · comments

commented

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.