readmeio / rdme

ReadMe's official command-line interface (CLI) and GitHub Action 🌊
https://docs.readme.com/main/docs/rdme
MIT License
106 stars 42 forks source link

No indication of where missing token error occurs with `openapi:validate` command #1046

Open lukevance opened 1 month ago

lukevance commented 1 month ago

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:

image

From what I can tell, this project structure is relatively common:

readme_project/
  api_reference.yaml
  components/
    schemas/
      Pet.yaml
      Category.yaml
      User.yaml

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.

e.g.

rdme openapi:validate api_reference.yaml