Add dedicated OData API support (extract & publish)
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 48/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- azure, typescript
調査の方向性
api-extractor.ts、api-publisher.ts、apim-client.ts から始め、既存の apiType の処理と getExportFormat()/getImportFormat() のパスを追跡します。OData/CSDL のエクスポート形式とインポート形式を確認するため、APIM API 形式のドキュメントまたは既存のクライアント動作を確認します。OData のエンティティ セットと関数が extract と publish を通過して保持され、両方のフローをカバーする単体テストまたは統合テストがあれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Summary
apiops-cli currently handles OData APIs via the generic OpenAPI fallback path, which does not capture OData-specific artifacts. This issue tracks adding first-class OData support to both the extractor and publisher.
Background
Azure API Management added OData API support, but tooling across the ecosystem has lagged behind (see Azure/apiops#419). Users report that entity sets and functions are lost when extracting/publishing OData APIs.
Current behavior
- Extractor (
api-extractor.ts): No special-case handling forodataAPI type — it falls through to the genericopenapi-linkexport, which misses OData-specific resources. - Publisher (
api-publisher.ts): Recognizesodataas a validapiTypestring but has no OData-specific import format or schema handling. - APIM Client (
apim-client.ts):getExportFormat()returns'openapi-link'for OData via thedefaultcase — no dedicated export format.
What needs to change
- Extract: Add OData-specific handling in
api-extractor.tsto export CSDL schemas, entity sets, and functions via the appropriate APIM export format. - APIM Client: Add an
'odata'case togetExportFormat()returning the correct APIM export format for OData APIs (investigate whether APIM supports a dedicated OData/CSDL export link). - Publish: Add OData-specific import format handling in
getImportFormat()so that CSDL schemas and entity sets are correctly imported on publish. - Tests: Add unit/integration tests covering OData extract and publish flows.
Related
- Azure/apiops#419 — original feature request in the apiops toolkit repo
- 主要言語
- TypeScript
- スター
- 29
- フォーク
- 10
- 平均マージ
- 1日 14時間
- マージ済み PR（30日）
- 22
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Azure/apiops-cli のほかの issue
-
type:question
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
Azure/apiops-cli#277 ·
-
type:documentation
難易度 1/5 1時間未満 初心者へのやさしさ 94/100
Azure/apiops-cli#250 ·
-
Documentation P2
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
Azure/apiops-cli#24 · コメント 1 件 ·
-
type:bug
難易度 4/5 3〜5日 初心者へのやさしさ 55/100
Azure/apiops-cli#291 ·
-
type:bug
難易度 3/5 1〜2日 初心者へのやさしさ 58/100
Azure/apiops-cli#276 ·
Azure/apiops-cli の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
calcite-components needs triage refactor
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
Esri/calcite-design-system#15203 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
danielmiessler/LifeOS#2218 ·