Circular references in external documents create an infinite recursion

Offen

#1,985 erstellt am 12.12.2024 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 45/100

Issue-Typ: Bug
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: csharp
Bereich: api

Rechercherichtung

Reproduziere die Rekursion mit den verknüpften Dateien pet.json und pets2.json mithilfe des bereitgestellten Kiota Docker-Befehls und verfolge anschließend, wie externe Dokumente während der Referenzauflösung in Workspaces geladen werden. Vergleiche den angehängten circular_ref.patch mit dem aktuellen Verhalten; als abgeschlossen gilt die Aufgabe, wenn sich gegenseitig referenzierende externe Dokumente ohne unendliche Rekursion auflösen lassen und dabei im vorgesehenen Workspace verbleiben.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Describe the bug
Open api documents that contain circular references create an infinite recursion because each external document is loaded into a new root workspace rather than the initial document loader workspace.

OpenApi File To Reproduce
In order to reproduce, you need two files that reference each other. I've put a circular reference in the schemas section of the below specs (this is not the exact problem I'm seeing with real documents, but it's close enough to reproduce). The references are hard coded to a mount directory because I'm using kiota as a driver, so you may need to update the paths if you run against a different location.

pet.json
pets2.json

Expected behavior
I believe external documents should all be loaded into the same workspace for reference resolution.

Screenshots/Code Snippets

docker run --rm `
    -v "${PWD}\output:/app/output" `
    -v "${PWD}\specs:/app/specs" `
    -u root `
    mcr.microsoft.com/openapi/kiota generate --language csharp -n MyCode --openapi ./specs/pet.json --log-level trace

I have encountered the problem in open api documents from large enterprise software providers, so I've attached a patch file that contains my work around for an internal fork of the document loader libraries. Adding external documents to the root workspace created by the initial document load appears to resolve the problem, though I'm not sure if the external references are being resolved correctly.

This patch includes the changes I was required to make in order to resolve locally.
circular_ref.patch

Vorherrschende Sprache: C#
Sterne: 1.6k
Forks: 286
Ø Merge: 6 Std. 38 Min.
Gemergte PRs (30 T.): 35

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus microsoft/OpenAPI.NET

Support ability to return compact JSON format when calling SerializeAsJsonAsync Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100

microsoft/OpenAPI.NET#2798 · Erstellt am 23.3.2026
OpenApiYamlReader.Read inconsistent behavior for errors Offen

microsoft/OpenAPI.NET#3056 · 1 Kommentar · 1 Reaktion · 2 zugewiesene Personen · Erstellt am 28.8.2026
Update SharpYaml dependency to v3.x Offen

type:breaking-change

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 52/100

microsoft/OpenAPI.NET#3014 · 2 Kommentare · Erstellt am 12.8.2026
Implement equality (`IEquatable<T>` and override object.Equals/GetHashCode) for object models Offen

help wanted

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 35/100

microsoft/OpenAPI.NET#2989 · 3 Kommentare · Erstellt am 23.7.2026
Regression: broken nullability after update to v3.9.0 Offen

help wanted type:feature

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100

microsoft/OpenAPI.NET#2967 · 18 Kommentare · 1 Reaktion · Erstellt am 18.7.2026

Alle Issues in microsoft/OpenAPI.NET