Exhaustive OData Navigation Path Generation Problem
Mantenedores costumam responder em até 2 dias
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- openapi
- Domínio
- api, developer-experience
Direção de pesquisa
Nenhum arquivo-fonte, teste ou ponto de entrada é indicado. Comece localizando o fluxo de geração do Microsoft.OpenApi.OData e reproduzindo a especificação 35MB v1.0; em seguida, compare uma saída limitada por profundidade ou filtrada com a prova de conceito de 21 caminhos. A conclusão deve incluir uma redução prática no número de caminhos e no tamanho da especificação sem perder as operações diretas necessárias.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
OpenAPI Spec is 35MB Due to Exhaustive OData Navigation Path Generation
Problem:
The generated OpenAPI spec (v1.0) is 35MB with 10,405 paths, making it unusable in API clients (Insomnia, Postman, Swagger UI). The root cause is that the spec includes every possible navigation path through the object graph, not just useful endpoints.
Example of Path Explosion:
A single resource like /drives/{id}/items/{id} generates 1,505 paths because it includes every nested relationship:
/drives/{id}/items/{id} - the actual file (useful)
/drives/{id}/items/{id}/createdByUser - navigate to creator
/drives/{id}/items/{id}/createdByUser/manager - creator's manager
/drives/{id}/items/{id}/createdByUser/manager/directReports/{id} - manager's team
/drives/{id}/items/{id}/createdByUser/manager/directReports/{id}/photo - their photos
... continues 5-10 levels deep
Reality Check:
Nobody uses /drives/{id}/items/{id}/createdByUser/manager/photo - they'd call /users/{id}/photo directly. These navigation paths are technically valid in OData but practically useless.
Analysis:
10,405 paths (most are nested navigation bloat)
4,292 schemas (3,242 unused - 75%)
1,157 responses (521 unused - 45%)
2,360 examples (all unused)
Impact:
Clients freeze/crash loading the spec
Impossible to explore the API effectively
Poor developer experience
Proposed Remedies:
Option 1: Limit navigation depth (Recommended)
Configure Microsoft.OpenApi.OData to only generate direct resource operations, not nested navigation paths. Max depth of 1 would reduce 10K paths to ~500-1000 useful endpoints.
Option 2: Split by service area
Publish separate specs per service:
openapi-files.yaml - drives/items/sites (core file operations only)
openapi-users.yaml - users/groups
openapi-mail.yaml - messages/mailFolders
openapi-calendar.yaml - events/calendars
etc.
Option 3: Provide filtered variants
openapi-full.yaml - complete with all navigation (current)
openapi-core.yaml - direct operations only, no nested navigation
openapi-{service}.yaml - per-service splits
Option 4: Post-generation pruning
Add a build step that removes:
Navigation paths beyond depth 1
Unused schemas/responses
All examples (2,360 unused)
Proof of Concept:
Filtering to just essential file operations (21 paths) reduces the spec from 35MB to 1.1MB - a 97% reduction while maintaining full functionality.
- Linguagem predominante
- XSLT
- Estrelas
- 171
- Forks
- 56
- Merge médio
- 1d 11h
- PRs com merge (30d)
- 9
Preparar o ambiente
Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
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 microsoftgraph/msgraph-metadata
-
ToTriage
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 86/100
microsoftgraph/msgraph-metadata#1217 ·
Mantenedores costumam responder em até 2 dias
-
ToTriage
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
microsoftgraph/msgraph-metadata#1192 ·
Mantenedores costumam responder em até 2 dias
-
ToTriage
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 57/100
microsoftgraph/msgraph-metadata#1233 ·
Mantenedores costumam responder em até 2 dias
-
`microsoft.graph.managedDevice` is missing a filter restrictions annotation.Talvez já em andamento @esidorenko-sl assumiu há 86 dias. AbertaToTriage
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 72/100
microsoftgraph/msgraph-metadata#1193 · 2 comentários ·
Mantenedores costumam responder em até 2 dias
-
ToTriage
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 45/100
microsoftgraph/msgraph-metadata#1169 · 1 reação ·
Mantenedores costumam responder em até 2 dias
Todas as issues de microsoftgraph/msgraph-metadata
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
matomo-org/plugin-CustomAlerts#310 ·
Mantenedores costumam responder em até 1 dia
-
bug level:trivial
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
exoego/keycloak-fuhito#666 ·
Mantenedores costumam responder em até 1 dia
-
bug size:small
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
Mantenedores costumam responder em até 1 dia
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 66/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
fb55/htmlparser2#2579 ·
Mantenedores costumam responder em até 1 dia