Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
lukevance opened this issue Sep 24, 2024 · 0 comments
Labels
command:openapi Issues pertaining to the `openapi`, `validate`, `reduce`, or `swagger` commands help wanted Extra attention is needed

Comments

@lukevance
Copy link

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
@erunion erunion added help wanted Extra attention is needed command:openapi Issues pertaining to the `openapi`, `validate`, `reduce`, or `swagger` commands labels Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
command:openapi Issues pertaining to the `openapi`, `validate`, `reduce`, or `swagger` commands help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants