Exhaustive OData Navigation Path Generation Problem
Los mantenedores suelen responder en 2 días
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- openapi
- Área
- api, developer-experience
Línea de trabajo
No se nombran archivos fuente, pruebas ni puntos de entrada. Empieza por localizar el flujo de generación de Microsoft.OpenApi.OData y reproducir la especificación 35MB v1.0; después, compara una salida limitada por profundidad o filtrada con la prueba de concepto de 21 rutas. El resultado debería incluir una reducción práctica del número de rutas y del tamaño de la especificación sin perder las operaciones directas requeridas.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- XSLT
- Estrellas
- 171
- Forks
- 56
- Merge medio
- 1 d 11 h
- PR fusionados (30 d)
- 9
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de microsoftgraph/msgraph-metadata
-
ToTriage
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
microsoftgraph/msgraph-metadata#1217 ·
Los mantenedores suelen responder en 2 días
-
ToTriage
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
microsoftgraph/msgraph-metadata#1192 ·
Los mantenedores suelen responder en 2 días
-
ToTriage
Dificultad 3/5 1-2 días Aptitud para principiantes 57/100
microsoftgraph/msgraph-metadata#1233 ·
Los mantenedores suelen responder en 2 días
-
`microsoft.graph.managedDevice` is missing a filter restrictions annotation.Posiblemente ocupada @esidorenko-sl la tomó hace 86 días. AbiertoToTriage
Dificultad 3/5 1-2 días Aptitud para principiantes 72/100
microsoftgraph/msgraph-metadata#1193 · 2 comentarios ·
Los mantenedores suelen responder en 2 días
-
ToTriage
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
microsoftgraph/msgraph-metadata#1169 · 1 reacción ·
Los mantenedores suelen responder en 2 días
Todos los issues de microsoftgraph/msgraph-metadata
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
matomo-org/plugin-CustomAlerts#310 ·
Los mantenedores suelen responder en 1 día
-
A CSV row that removes a language with #CLEAR and fills another name of it keeps one of themAbiertobug level:trivial
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
exoego/keycloak-fuhito#666 ·
Los mantenedores suelen responder en 1 día
-
bug size:small
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
fb55/htmlparser2#2579 ·
Los mantenedores suelen responder en 1 día