Azure APIM ignores path refs in OpenAPI spec file

Question

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).

Answer 1

@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.