Azure / Azure/apiops-cli

Add dedicated OData API support (extract & publish)

Aberta
#124 1 comentário 0 reações 0 responsáveis Ver no GitHub
Enhancement P2
Linguagem predominante
TypeScript
Estrelas
26
Forks
9
Merge médio
1d 3h
PRs com merge (30d)
20

Descrição

## 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](https://github.com/Azure/apiops/issues/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 for `odata` API type — it falls through to the generic `openapi-link` export, which misses OData-specific resources.
- **Publisher** (`api-publisher.ts`): Recognizes `odata` as a valid `apiType` string but has no OData-specific import format or schema handling.
- **APIM Client** (`apim-client.ts`): `getExportFormat()` returns `'openapi-link'` for OData via the `default` case — no dedicated export format.

## What needs to change

1. **Extract**: Add OData-specific handling in `api-extractor.ts` to export CSDL schemas, entity sets, and functions via the appropriate APIM export format.
2. **APIM Client**: Add an `'odata'` case to `getExportFormat()` returning the correct APIM export format for OData APIs (investigate whether APIM supports a dedicated OData/CSDL export link).
3. **Publish**: Add OData-specific import format handling in `getImportFormat()` so that CSDL schemas and entity sets are correctly imported on publish.
4. **Tests**: Add unit/integration tests covering OData extract and publish flows.

## Related

- [Azure/apiops#419](https://github.com/Azure/apiops/issues/419) — original feature request in the apiops toolkit repo

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Comece em api-extractor.ts, api-publisher.ts e apim-client.ts, rastreando o tratamento existente de apiType e os caminhos de getExportFormat()/getImportFormat(). Consulte a documentação de formatos de API do APIM ou o comportamento existente do cliente para confirmar os formatos de exportação e importação OData/CSDL. Está concluído quando os conjuntos de entidades e as funções OData forem preservados durante a extração e a publicação, com testes unitários ou de integração cobrindo ambos os fluxos.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
azure, typescript
Domínio
api, cli
Tipo de issue
Funcionalidade
Dificuldade
4/5
Tempo estimado
3-5 dias
Status de atividade
Pouca atividade
Clareza
Razoavelmente clara
Facilidade para iniciantes
48/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.