Skip to content

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

Open
@lukevance

Description

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

Metadata

Assignees

No one assigned

    Labels

    command:openapiIssues pertaining to the `openapi`, `validate`, `reduce`, or `swagger` commandshelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions