Add dedicated OData API support (extract & publish)
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 48/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- azure, typescript
Research direction
Start in api-extractor.ts, api-publisher.ts, and apim-client.ts, tracing the existing apiType handling and getExportFormat()/getImportFormat() paths. Check the APIM API format documentation or existing client behavior to confirm the OData/CSDL export and import formats. Done means OData entity sets and functions survive extract and publish, with unit or integration tests covering both flows.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- TypeScript
- Stars
- 29
- Forks
- 10
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 22
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Azure/apiops-cli
-
type:question
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Azure/apiops-cli#277 ·
-
type:documentation
Difficulty 1/5 Under an hour Newbie friendliness 94/100
Azure/apiops-cli#250 ·
-
Documentation P2
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Azure/apiops-cli#24 · 1 comment ·
-
type:bug
Difficulty 4/5 3-5 days Newbie friendliness 55/100
Azure/apiops-cli#291 ·
-
type:bug
Difficulty 3/5 1-2 days Newbie friendliness 58/100
Azure/apiops-cli#276 ·
All issues in Azure/apiops-cli
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 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
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
fullcalendar/fullcalendar#8106 ·