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

Identify bad or invalid $ref's with a warning #86

Closed
jc43081 opened this issue Oct 19, 2020 · 2 comments
Closed

Identify bad or invalid $ref's with a warning #86

jc43081 opened this issue Oct 19, 2020 · 2 comments

Comments

@jc43081
Copy link

jc43081 commented Oct 19, 2020

When a $ref does not resolve either within the document or to an external model, the OAS becomes invalid. If the Preview is not open and you try to open it with a bad reference, it will warn you of the problem and tell you which reference is invalid.

If the Preview is already open, the Preview will stop updating until the bad reference is resolved. No warning or indication is given to the problem.

Enhancement Request.
Add a visual warning to the bad reference and add it to the Problems view.

@ak1394
Copy link
Collaborator

ak1394 commented Dec 1, 2020

Thanks for the report! We plan to do better error reporting for broken $refs, likely in the next release or one after that.

@ak1394
Copy link
Collaborator

ak1394 commented Jan 4, 2021

Fixed in the upcoming 3.10.0. For now the invalid refs will be shown only in audit or preview mode, but in the future version we will be showing invalid refs in the normal editing mode as well.

@ak1394 ak1394 closed this as completed Jan 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants