APIM REST-API for schemas broken above version 2021-08-01

Edwin van de Burgt 11 Reputation points
2025-06-27T12:57:00.09+00:00

Version 2021-08-01 and before of the "Api Schema - List by Api" (https://learn.microsoft.com/en-us/rest/api/apimanagement/api-schema/list-by-api?view=rest-apimanagement-2021-08-01&tabs=HTTP) lists the schema's configured for the API. Versions above that, do not.

The documentation is inconsistent and the sample response does not match the real response for a lot of Api versions.

https://management.azure.com/subscriptions/{subscription}/resourceGroups/{rg}/providers/Microsoft.ApiManagement/service/{service}/apis/{api}/schemas?api-version=2021-08-01:

{
    "value": [
        {
            "id": "/subscriptions/.../resourceGroups/.../providers/Microsoft.ApiManagement/service/.../apis/.../schemas/apiSchemas",
            "type": "Microsoft.ApiManagement/service/apis/schemas",
            "name": "apiSchemas",
            "properties": {
                "contentType": "application/vnd.oai.openapi.components+json",
                "document": {
                    "components": {
                        "schemas": {
                            "createSomeObjectRequest": {
                                "properties": { ...

https://management.azure.com/subscriptions/{subscription}/resourceGroups/{rg}/providers/Microsoft.ApiManagement/service/{service}/apis/{api}/schemas?api-version=2024-05-01:

{
    "value": [
        {
            "id": "/subscriptions/.../resourceGroups/.../providers/Microsoft.ApiManagement/service/.../apis/.../schemas/apiSchemas",
            "type": "Microsoft.ApiManagement/service/apis/schemas",
            "name": "apiSchemas",
            "properties": {
                "contentType": "application/vnd.oai.openapi.components+json"
            }
        }
    ],
    "count": 1
}

Api's above version 2021-08-01 don't have the document node, hence provide no schema information.

Azure API Management
Azure API Management
An Azure service that provides a hybrid, multi-cloud management platform for APIs.
2,447 questions
0 comments No comments
{count} vote

Your answer

Answers can be marked as Accepted Answers by the question author, which helps users to know the answer solved the author's problem.