Azure / Azure/openapi-diff

Allowing circular references

Open
#274 5 comments 5 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
290
Forks
50
Avg merge
5d 13h
Merged PRs (30d)
5

Description

Is there a way to generate the report allowing for circular dependencies on the parameters?

```
OpenApiDiffErrorImpl [VError]: ReferenceError: Circular $ref pointer found at /builds/#/components/schemas/Content/properties/children/items
at /usr/local/lib/node_modules/openapi-diff/dist/openapi-diff/spec-differ/diff-finder/json-schema-diff.js:27:15
at Generator.throw ()
at rejected (/usr/local/lib/node_modules/openapi-diff/dist/openapi-diff/spec-differ/diff-finder/json-schema-diff.js:6:65) {
jse_shortmsg: 'ReferenceError: Circular $ref pointer found at /builds/#/components/schemas/Content/properties/children/items',
jse_info: {},
code: 'OPENAPI_DIFF_DIFF_ERROR'
}
```

Thank you!

Contributor guide

Open the contributing guide

Research direction

Start at openapi-diff/dist/openapi-diff/spec-differ/diff-finder/json-schema-diff.js, where the circular $ref error is reported, and trace how the Content schema is compared. Determine the intended behavior for /components/schemas/Content/properties/children/items and define completion as generating a report without failing on that circular reference, with coverage for the example specification.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, openapi
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.