Docs/render open api link#207
Open
Unclebaffa wants to merge 10 commits into
Open
Conversation
…cure external link
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of Completed Work
Page Update:
src/app/docs/page.tsxto validate the OpenAPI and GitHub external links throughsafeHref.target="_blank"andrel="noopener noreferrer"attributes on the external GitHub link.Tests:
src/app/docs/page.test.tsxto verify correcttargetandrelattribute handling on both links.jest.spyOn()to mocksafeHrefwithout causing recursion issues.Documentation:
README.mdto note that/docslinks are validated throughsafeHref.Commits:
feat(docs): route relative and external links through safeHref and secure external linktest(docs): assert target and rel attributes for docs linkstest(docs): add test coverage for docs link safety validation fallbackdocs(README): document link safety validation on the docs pageValidation & Verification:
npm run lint,npm run typecheck,npm test(coverage), andnpm run buildsuccessfully with zero errors.For more details, please see the implementation_plan.md and walkthrough.md artifacts.
Closes #143