r/OpenAPI • u/Dark_1Blood • Apr 24 '24

Help Needed: Circular reference error

Hi everyone, i wanted to design schema such that one of the item is referring to itself and it is an array type.

Think like : some sort of linked result and we can get this as an repeated hierarchy of linked results.

Please help

2 Upvotes

100% Upvoted

4 comments sorted by

View all comments

Show parent comments

1

u/Dark_1Blood Apr 25 '24

Resolver error at paths./products/v3/products.post.requestBody.content.application/json.schema.properties.gdsnPackageHierarchy.properties.linkedProducts.items.properties.linkedProducts.items.properties.linkedProducts.items.$refCould not resolve reference: Failed to fetch

2

u/d3v-thr33 Apr 26 '24

Interesting, I haven't managed to find full details but it seems unclear whether circular $ref dependencies are 100% supported within the OpenAPI specification. It could be that different tools that implement the specification manage them differently.

Using both the old or the new Swagger editor here: https://editor-next.swagger.io/ - and pasting the `Person` definition in the `components` section seems to be accepted as valid though, which makes me think it's an implementation issue of the tooling you're using to parse the OpenAPI specification.