[FEATURE REQ] Add support for APIM Schema extraction in APIOps
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 35/100
Hướng nghiên cứu
Bắt đầu bằng cách đọc các khu vực APIOps Extractor và Publisher cùng với APIM Schemas REST API được tham chiếu và mô hình tài nguyên Microsoft.ApiManagement/service/schemas. Hoàn tất nghĩa là trích xuất siêu dữ liệu và nội dung của schema, triển khai schema trước khi tham chiếu đến các API, và ghi lại khả năng này trong Limitations nếu phù hợp.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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
- Ngôn ngữ chính
- C#
- Star
- 448
- Fork
- 247
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của Azure/apiops
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 55/100
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 52/100
Issue tương tự
-
type/automation type/tech-debt
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
-
t/bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
-
ci-failure-cause test-failure
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
-
area:auth FE mvp P3
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
klasolsson81/jobbliggaren#1788 ·