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

Documentation on circular references is wrong #680

Open
JaredAAT opened this issue Dec 2, 2024 · 0 comments
Open

Documentation on circular references is wrong #680

JaredAAT opened this issue Dec 2, 2024 · 0 comments

Comments

@JaredAAT
Copy link

JaredAAT commented Dec 2, 2024

I have an openAPI spec that has circular references, this led to an error when using portman to generate my postman files, which asked me to look at the documentation here: https://github.com/apideck-libraries/portman/blob/2bbea0a632310af2834b3097d96dbf892f70a814/docs/ERRORS.md

Having spoken with people on the OpenAPI slack group, they suggest:

That documentation is at best misleading. OpenAPI supports circular references of the kind described in that documentation. At least in both 3.0 and 3.1, and I don't see any note against it in 2.0 at a quick glance.

As a tooling author myself, i know the pain of Circular references, but it might be best for the community to re-word the documentation

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