Exhaustive OData Navigation Path Generation Problem
I maintainer di solito rispondono entro 2 giorni
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- openapi
- Ambito
- api, developer-experience
Direzione di ricerca
Non sono indicati file sorgente, test o punti di ingresso. Inizia individuando il flusso di generazione di Microsoft.OpenApi.OData e riproducendo la specifica 35MB v1.0; quindi confronta un output con profondità limitata o filtrato con la prova di concetto a 21 percorsi. Il risultato dovrebbe includere una riduzione pratica dei percorsi e delle dimensioni della specifica senza perdere le operazioni dirette richieste.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- XSLT
- Stelle
- 171
- Fork
- 56
- Merge medio
- 1g 11h
- PR unite (30g)
- 9
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di microsoftgraph/msgraph-metadata
-
ToTriage
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
microsoftgraph/msgraph-metadata#1217 ·
I maintainer di solito rispondono entro 2 giorni
-
ToTriage
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
microsoftgraph/msgraph-metadata#1192 ·
I maintainer di solito rispondono entro 2 giorni
-
ToTriage
Difficoltà 3/5 1-2 giorni Idoneità per principianti 57/100
microsoftgraph/msgraph-metadata#1233 ·
I maintainer di solito rispondono entro 2 giorni
-
`microsoft.graph.managedDevice` is missing a filter restrictions annotation.Forse già presa @esidorenko-sl l’ha presa 86 giorni fa. ApertaToTriage
Difficoltà 3/5 1-2 giorni Idoneità per principianti 72/100
microsoftgraph/msgraph-metadata#1193 · 2 commenti ·
I maintainer di solito rispondono entro 2 giorni
-
ToTriage
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
microsoftgraph/msgraph-metadata#1169 · 1 reazione ·
I maintainer di solito rispondono entro 2 giorni
Tutte le issue di microsoftgraph/msgraph-metadata
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
matomo-org/plugin-CustomAlerts#310 ·
I maintainer di solito rispondono entro 1 giorno
-
bug level:trivial
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
exoego/keycloak-fuhito#666 ·
I maintainer di solito rispondono entro 1 giorno
-
bug size:small
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 66/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
fb55/htmlparser2#2579 ·
I maintainer di solito rispondono entro 1 giorno