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

Include documentation URLs for built-in rulesets #2586

Open
dillan opened this issue Feb 19, 2024 · 0 comments
Open

Include documentation URLs for built-in rulesets #2586

dillan opened this issue Feb 19, 2024 · 0 comments
Labels
enhancement New feature or request triaged

Comments

@dillan
Copy link

dillan commented Feb 19, 2024

User story.
As a Spectral user, I can click on a documentation URL, so that I can get more context for why a rule has failed, so that I may address the issue more quickly.

Is your feature request related to a problem?
While the concise message helps me quickly understand what the issue is for a lint result, providing more context or proposed solutions can help users address the issue more quickly, accurately, and completely.

The ruleset docs like the one linked below provide a wealth of info, including both good and bad examples. This context can save Spectral uses a lot of time and frustration if they have quick access to this information. https://docs.stoplight.io/docs/spectral/4dec24461f3af-open-api-rules#oas3-server-variables

Describe the solution you'd like
For each Spectral lint result, include the documentationURL for all built-in rulesets. Especially for machine-readable output formats like JSON. Ideally, each lint result would also identify the ruleset that the failing rule came from.

Additional context
Relates to: #2443

@mnaumanali94 mnaumanali94 added the enhancement New feature or request label May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triaged
Projects
None yet
Development

No branches or pull requests

2 participants