docs(openapi): add clickable cross-links for translations/tafsirs in /verses query params (v4)

[basit3407]

Summary

Adds clickable cross-links in all /verses endpoint query parameters to help users find available resource IDs for translations and tafsirs.

Changes

• Updated openAPI/content/v4.json:

  • translations: “See [/resources/translations](/resources/translations) for available ids.”
  • tafsirs: “See [/resources/tafsirs](/resources/tafsirs) for available ids.”

• Ensured links render as Markdown so they’re clickable in the docs UI.

Affected Endpoints

• /verses/by_chapter/{chapter_number}
• /verses/by_page/{page_number}
• /verses/by_juz/{juz_number}
• /verses/by_hizb/{hizb_number}
• /verses/by_rub/{rub_el_hizb_number}
• /verses/by_key/{verse_key}
• /verses/random

Rationale

• Improve discoverability of valid resource IDs for consumers.
• Keep parameter descriptions consistent across all /verses endpoints.
• No behavioral changes; docs-only improvement.

Files Changed

• openAPI/content/v4.json

How to Test

1. Clean and rebuild:

   yarn clean-all && yarn clear
   yarn build && yarn serve

2. In the served site, navigate to Content APIs → Verses:

   • Check the Parameters tab on each endpoint above.

   • Confirm the “translations” and “tafsirs” descriptions include clickable links:

     • /docs/content_apis_versioned/translations
     • /docs/content_apis_versioned/tafsirs

3. Optionally verify source:

   • Open openAPI/content/v4.json and search for:

     • "/docs/content_apis_versioned/translations"
     • "/docs/content_apis_versioned/tafsirs"

Impact

• Scope: Documentation only.
• Risk: Low. No runtime or API surface changes.

Checklist

• Docs build succeeds (yarn build)
• Links render as clickable in all /verses pages
• No changes outside openAPI/content/v4.json

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
qf-api-docs	Ready	Preview	Comment	Sep 10, 2025 7:00am