API Management schema definitions. Why they are auto generated for query parameters?

Question

Hi.
I have built a multi tier environment with apiops tool CI/CD. I want to keep the configuration as clean as possible at all times and I have a question about schema defintitions.

When query params are added in portal, APIM creates a schmea definition for each and links it in the API YAML definition.
I do not wish this to happen as I want the defintions list to stay clean and only have the schemas I wish there to be.
Even if I delete them and clean the references from YAML spec file, they seem to come back. I already had some deployment issues because of this.

I can live with them, but I dont see any true need for them to exist. Why do they auto generate?

Answer 1

@KAUPPINEN Miro Thanks for reaching out. From the description I understand that you need to keep your APIM configuration clean and organized, and I you wanted to avoid auto-generated schema definitions for query parameters.

Unfortunately, the auto-generation of schema definitions for query parameters is a default behavior in APIM and is by design. There is currently no way to turn off this behavior.

While I understand that this may not be ideal for your specific use case, it's important to note that the auto-generated schema definitions are intended to provide a consistent and standardized way of defining the data types and formats of query parameters across all APIs in your organization. This helps to ensure that APIs are properly documented and that clients can easily understand how to interact with them.

feel free to leave your feedback at aka.ms/apimwish. do let me know incase of further queries, I would be happy to assist you.