I have been breaking out primary openapi spec file into more maintainable chunks but I've noticed with validating the primary file, if a child file has an error in it, the error is generic and does not point to where the problem occurred leading to a frustrating hunting and pecking procedure:
From what I can tell, this project structure is relatively common:
In this example, if the Pet.yaml component has a broken reference to the Category.yaml file, running the validate command on the primary api_reference.yaml file will not give any indication which component contains the error that was thrown.
I have been breaking out primary openapi spec file into more maintainable chunks but I've noticed with validating the primary file, if a child file has an error in it, the error is generic and does not point to where the problem occurred leading to a frustrating hunting and pecking procedure:
From what I can tell, this project structure is relatively common:
In this example, if the
Pet.yaml
component has a broken reference to theCategory.yaml
file, running the validate command on the primaryapi_reference.yaml
file will not give any indication which component contains the error that was thrown.e.g.