Skip to content

Documentation on circular references is wrong #680

Description

@JaredAAT

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions