Skip to content

Replace <see href="link">text</see> with Markdown link format#2392

Merged
martincostello merged 1 commit into
domaindrivendev:masterfrom
mburumaxwell:master
Apr 15, 2024
Merged

Replace <see href="link">text</see> with Markdown link format#2392
martincostello merged 1 commit into
domaindrivendev:masterfrom
mburumaxwell:master

Conversation

@mburumaxwell

@mburumaxwell mburumaxwell commented Mar 31, 2022

Copy link
Copy Markdown
Contributor

<see href="link">text</see> tags are currently not replaced. The expected format for descriptions in OpenAPI/Swagger is markdown. Redoc does not generate a link for <see href="link">text</see> but instead displays the inner text as-is.

This PR changes the behaviour to use GitHub-flavoured markdown, instead - text tags are replaced with a clickable link. Redoc supports this style of links out of the box.

Fixes: #2577

@mburumaxwell

Copy link
Copy Markdown
Contributor Author

@domaindrivendev any thoughts on this?

@mburumaxwell

Copy link
Copy Markdown
Contributor Author

@domaindrivendev any hopes?

@Hyo-Seong

Copy link
Copy Markdown

@domaindrivendev I want it too!!

@martincostello

Copy link
Copy Markdown
Collaborator

Thanks for contributing - if you'd like to continue with this pull request, please rebase against the default branch to pick up our new CI.

@Hyo-Seong

Copy link
Copy Markdown

knock knock

@codecov-commenter

codecov-commenter commented Apr 15, 2024

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.70%. Comparing base (0108842) to head (5c49b58).
⚠️ Report is 532 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2392   +/-   ##
=======================================
  Coverage   91.69%   91.70%           
=======================================
  Files          91       91           
  Lines        3022     3025    +3     
  Branches      519      519           
=======================================
+ Hits         2771     2774    +3     
  Misses        251      251           
Flag Coverage Δ
Linux 91.70% <100.00%> (+<0.01%) ⬆️
Windows 91.70% <100.00%> (+<0.01%) ⬆️
macOS 91.70% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@martincostello martincostello added this to the v6.5.1 milestone Apr 15, 2024
@martincostello martincostello merged commit 45a2cb7 into domaindrivendev:master Apr 15, 2024
@martincostello martincostello modified the milestones: v6.5.1, v6.6.0 Apr 18, 2024
This was referenced Jun 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

<see href="link">text</see> is not converted to correct Markdown link

4 participants