Azure APIM ignores path refs in OpenAPI spec file

David Kubecka 0 Reputation points
2024-12-20T15:09:28.35+00:00

Consider the following openAPI spec snippet:

openapi: 3.0.3
info:
  version: 1.0.0
  title: MyTestApi

  paths:
    /a:
      get:
         ...
    /b:
      $ref: '#/paths/~1a'

The paths specification is valid according to OpenAPI 3, yet the path /b is ignored when I import this spec into APIM (/a gets imported correctly).

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

1 answer

Sort by: Most helpful
  1. Khadeer Ali 1,400 Reputation points Microsoft Vendor
    2024-12-21T00:11:53.6833333+00:00

    @David Kubecka

    Welcome to Microsoft Q&A!

    Thanks for reaching out about the issue with Azure APIM ignoring path references in your OpenAPI spec file.

    It appears you've encountered a known limitation with Azure API Management (APIM) when importing OpenAPI specifications that use $ref pointers for paths. While OpenAPI 3.0.3 supports this, APIM currently has some restrictions and known issues with certain OpenAPI import features.

    For more details on these limitations, please refer to the following documentation:

    API import restrictions and known issues

    If you have any further questions or need additional assistance, please don't hesitate to ask. I'm here to help.

    If this answer was helpful, please mark it as "Yes" to assist others in the community who might be facing similar issues.


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.