Skip to content

Feature/spectral rule docs urls #21#91

Merged
github-actions[bot] merged 1 commit intomainfrom
feature/add-documentation-url
Nov 19, 2025
Merged

Feature/spectral rule docs urls #21#91
github-actions[bot] merged 1 commit intomainfrom
feature/add-documentation-url

Conversation

@andreyyudin
Copy link
Contributor

Closes #21

Summary

Add documentationUrl metadata to every Spectral rule so lint output can link directly to the rule guidance.

Changes Made

  • Ruleset updates: added documentationUrl to every rule in .spectral.yaml, pointing at the corresponding docs/spectral-rules/ page.
  • Spectral CLI guidance: updated CLI examples (e.g., docs/spectral-rules/index.md) to always pass --show-documentation-url, noting Spectral CLI 6.15.0+ is required to surface those links.
  • Authoring guidelines: expanded contributor docs with instructions on choosing and validating documentation URLs for new rules.

Testing / Verification

  • npx spectral lint example/example.1.0.0.oas.yml --show-documentation-url to confirm each violation now prints the expected link.
  • Manually checked linked docs pages to ensure they exist and describe the referenced rules.

@andreyyudin andreyyudin requested a review from a team as a code owner November 18, 2025 14:28
@github-actions
Copy link

github-actions bot commented Nov 18, 2025

Test Results

 1 files   8 suites   9s ⏱️
58 tests 58 ✅ 0 💤 0 ❌
59 runs  59 ✅ 0 💤 0 ❌

Results for commit 293d552.

♻️ This comment has been updated with latest results.

@andreyyudin andreyyudin force-pushed the feature/add-documentation-url branch from af146f0 to 293d552 Compare November 19, 2025 09:30
@andreyyudin andreyyudin added the fast-forward triggers fast-forward merge workflow label Nov 19, 2025
@github-actions
Copy link

🎉 Success! 🎉

PR successfully Fast Forward merged in ✅.

@github-actions github-actions bot merged commit 293d552 into main Nov 19, 2025
14 checks passed
@github-actions github-actions bot removed the fast-forward triggers fast-forward merge workflow label Nov 19, 2025
@github-actions github-actions bot deleted the feature/add-documentation-url branch November 19, 2025 10:20
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

Successfully merging this pull request may close these issues.

Add documentationUrl to each spectral rule

2 participants