microsoft / microsoft/OpenAPI.NET

Circular references in external documents create an infinite recursion

Aperta
#1,985 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
C#
Stelle
1.6k
Fork
286
Merge medio
6h 38m
PR unite (30g)
35

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Riproduci la ricorsione con i file collegati pet.json e pets2.json usando il comando Docker di Kiota fornito, quindi traccia il modo in cui i documenti esterni vengono caricati nei workspace durante la risoluzione dei riferimenti. Confronta il circular_ref.patch allegato con il comportamento attuale; il lavoro è considerato completato quando i documenti esterni che si referenziano reciprocamente vengono risolti senza ricorsione infinita, rimanendo nel workspace previsto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp
Ambito
api
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.