Circular references in external documents create an infinite recursion
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 45/100
Direção de pesquisa
Reproduza a recursão com os arquivos vinculados pet.json e pets2.json usando o comando Docker do Kiota fornecido e, em seguida, rastreie como os documentos externos são carregados nos workspaces durante a resolução de referências. Compare o circular_ref.patch anexado com o comportamento atual; considera-se concluído quando documentos externos que fazem referência mútua são resolvidos sem recursão infinita, permanecendo no workspace pretendido.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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.
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
- Linguagem predominante
- C#
- Estrelas
- 1.6k
- Forks
- 286
- Merge médio
- 6h 38min
- PRs com merge (30d)
- 35
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de microsoft/OpenAPI.NET
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
microsoft/OpenAPI.NET#2798 ·
-
microsoft/OpenAPI.NET#3056 · 1 comentário · 1 reação · 2 responsáveis ·
-
type:breaking-change
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 52/100
microsoft/OpenAPI.NET#3014 · 2 comentários ·
-
Implement equality (`IEquatable<T>` and override object.Equals/GetHashCode) for object models Abertahelp wanted
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 35/100
microsoft/OpenAPI.NET#2989 · 3 comentários ·
-
help wanted type:feature
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 55/100
microsoft/OpenAPI.NET#2967 · 18 comentários · 1 reação ·
Todas as issues de microsoft/OpenAPI.NET
Issues semelhantes
-
Documentation
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
cake-build/cake#5024 ·
-
Frontend status/draft TechnicalDebt
Dificuldade 2/5 1-2 dias Facilidade para iniciantes 75/100
Altinn/altinn-auth#4143 ·
-
.NET Flaky Test Testing Tests
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
getsentry/sentry-dotnet#5617 · 1 comentário ·
-
:watch: Not Triaged dotnet-fsharp/svc
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 90/100
-
Client customer-reported needs-team-attention question Service Attention WebPubSub
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
Azure/azure-sdk-for-net#63292 · 3 comentários · 1 reação ·