[FEATURE REQ] Add support for APIM Schema extraction in APIOps

オープン
#868 コメント 3 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
azure, csharp
領域
api, cloud

調査の方向性

まず、参照されている APIM Schemas REST API および Microsoft.ApiManagement/service/schemas リソースモデルと併せて、APIOps Extractor と Publisher の領域を読みます。スキーマのメタデータとコンテンツを抽出し、API を参照する前にスキーマをデプロイし、必要に応じて Limitations の下にこの機能をドキュメント化できれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Please describe the feature.

Feature Request: Add support for APIM Schema extraction in APIOps

Summary

APIOps currently does not extract API Management Schemas (Microsoft.ApiManagement/service/schemas).
This prevents full‑fidelity environment replication and breaks parity with the APIM REST API and ARM/Bicep resource model.
I believe this has been requested for many years, but there has been no visible progress, and there is no documentation under the Limitations section regarding schema extraction.

This request is to add schema extraction + deployment support to the APIOps Extractor and Publisher

Problem

APIM schemas are first‑class ARM resources and are commonly used for:

  • XML/JSON schema validation
  • Reusable schema references across multiple APIs
  • Legacy SOAP/WSDL transformations
  • Contract‑driven integration patterns

However, APIOps does not extract or publish schemas. This results in:

  • Incomplete environment backups
  • Inconsistent deployments between environments
  • Manual schema management outside the APIOps workflow
  • Drift between APIM instances

This is a gap compared to other APIM resource types already supported by APIOps.


Requested Enhancement

1. Schema Extraction

Extract all schemas under:

/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.ApiManagement/service/{service}/schemas

Including:

  • Schema metadata
  • Schema content (XML, JSON, WSDL, XSD)
  • Schema type (xml, json, wsdl, xsd)
  • Associated API references (if applicable)
2. Schema Deployment

Publisher should deploy schemas before APIs that reference them.

3. Folder Structure Proposal

Suggested structure (aligned with existing APIOps conventions):

schemas/
{schemaName}/
schema.json
content.xml (or .json)


Why This Matters

  • APIM schemas are required for many enterprise API governance patterns.
  • Without schema extraction, APIOps cannot be used as a complete DevOps solution for APIM.
  • Manual schema management introduces drift and breaks reproducibility.
  • The APIM REST API already supports full schema CRUD operations, so APIOps can implement this without platform limitations.

References

APIM REST API – Schemas:
https://learn.microsoft.com/rest/api/apimanagement/2023-05-01-preview/schema

ARM Resource Type:
Microsoft.ApiManagement/service/schemas


主要言語
C#
スター
448
フォーク
247
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Azure/apiops のほかの issue

Azure/apiops の issue をすべて見る

似ている issue

C# の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。