Azure API Management does not appear to support `prefixItems` in OpenAPI specifications

Chris 1 Reputation point
2024-04-18T14:12:43.37+00:00

I'm trying to import an API using an OpenAPI 3.1 document (in JSON), and am receiving the following error message:

prefixItems is not a valid property

The documentation indicates that OpenAPI v3.1 is supported for API importing, and does not mention prefixItems being one of the unsupported parts.Am I doing something wrong here? How can I validate my OpenAPI document locally before trying to import it here? Note - using OpenAPI v3.0 is not an option for me.

Azure API Management
Azure API Management
An Azure service that provides a hybrid, multi-cloud management platform for APIs.
1,759 questions
Azure
Azure
A cloud computing platform and infrastructure for building, deploying and managing applications and services through a worldwide network of Microsoft-managed datacenters.
955 questions

1 answer

Sort by: Most helpful
Most helpful Newest Oldest
  1. JananiRamesh-MSFT 21,246 Reputation points
    2024-04-18T15:32:14.2733333+00:00

    Chris Thanks for reaching out. From the description I understand that you are trying to import an OpenAPI 3.1 document in JSON format, but you are receiving an error message saying that "prefixItems" is not a valid property. This error message indicates that there might be an issue with your OpenAPI document.

    there are some limitations and restrictions when importing an API. You can find more information in the following document: https://learn.microsoft.com/en-us/azure/api-management/api-management-api-import-restrictions

    To validate your OpenAPI document locally before importing it to APIM, you can use a third-party tool such as Swagger Editor: https://editor.swagger.io/

    please verify and let me know incase of further queries, I would be happy to assist you.