Add dedicated OData API support (extract & publish)
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 48/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- azure, typescript
调研方向
从 api-extractor.ts、api-publisher.ts 和 apim-client.ts 开始,跟踪现有的 apiType 处理以及 getExportFormat()/getImportFormat() 路径。检查 APIM API 格式文档或现有客户端行为,以确认 OData/CSDL 导出和导入格式。完成的标准是 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 小时
- 30 天内合并 PR
- 22
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 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 ·
相似的 Issue
-
Browser Waiting for: Product Owner
难度 2/5 1-3 小时 新手友好度 85/100
getsentry/sentry-javascript#24577 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 78/100
agilepathway/label-checker#640 ·
-
难度 2/5 1-3 小时 新手友好度 84/100
copse-dev/agent-pane#2953 ·
-
agentic-workflows
难度 1/5 1 小时以内 新手友好度 85/100
githubnext/rig#534 ·
-
automation missing-model model-sync provider:pioneer
难度 2/5 1-3 小时 新手友好度 76/100
anomalyco/models.dev#7701 ·