Exhaustive OData Navigation Path Generation Problem
メンテナーはふだん 2 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- openapi
調査の方向性
ソースファイル、テスト、エントリポイントは指定されていません。まず Microsoft.OpenApi.OData の生成フローを特定し、35MB v1.0 仕様を再現してから、深さ制限またはフィルタリングした出力を21パスの概念実証と比較します。完了条件には、必要な直接操作を失うことなく、パス数と仕様サイズを実用的に削減することを含める必要があります。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- XSLT
- スター
- 171
- フォーク
- 56
- 平均マージ
- 1日 11時間
- マージ済み PR(30日)
- 9
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
microsoftgraph/msgraph-metadata のほかの issue
-
ToTriage
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
microsoftgraph/msgraph-metadata#1217 ·
メンテナーはふだん 2 日以内に返信
-
ToTriage
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
microsoftgraph/msgraph-metadata#1192 ·
メンテナーはふだん 2 日以内に返信
-
ToTriage
難易度 3/5 1〜2日 初心者へのやさしさ 57/100
microsoftgraph/msgraph-metadata#1233 ·
メンテナーはふだん 2 日以内に返信
-
`microsoft.graph.managedDevice` is missing a filter restrictions annotation.対応中かも @esidorenko-sl が 86 日前に担当しました。 オープンToTriage
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
microsoftgraph/msgraph-metadata#1193 · コメント 2 件 ·
メンテナーはふだん 2 日以内に返信
-
ToTriage
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
microsoftgraph/msgraph-metadata#1169 · リアクション 1 件 ·
メンテナーはふだん 2 日以内に返信
microsoftgraph/msgraph-metadata の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
matomo-org/plugin-CustomAlerts#310 ·
メンテナーはふだん 1 日以内に返信
-
bug level:trivial
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
exoego/keycloak-fuhito#666 ·
メンテナーはふだん 1 日以内に返信
-
bug size:small
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
fb55/htmlparser2#2579 ·
メンテナーはふだん 1 日以内に返信