[FEATURE REQ] Add support for APIM Schema extraction in APIOps
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
Research direction
Start by reading the APIOps Extractor and Publisher areas alongside the referenced APIM Schemas REST API and Microsoft.ApiManagement/service/schemas resource model. Done means extracting schema metadata and content, deploying schemas before referencing APIs, and documenting the capability under Limitations if appropriate.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- C#
- Stars
- 448
- Forks
- 247
- PR merge metrics
- No merged PRs in 30d
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
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 52/100
Similar issues
-
type/automation type/tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
t/bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
ci-failure-cause test-failure
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area:auth FE mvp P3
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
klasolsson81/jobbliggaren#1788 ·