Skip to content
This repository was archived by the owner on Nov 28, 2025. It is now read-only.

Conversation

@sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Oct 28, 2025

User description

Contributor checklist

  • Reviewed PR Code suggestions and updated accordingly
  • Tyklings: Labled the PR with the relevant releases
  • Tyklings: Added Jira DX PR ticket to the subject

New Contributors



PR Type

Documentation


Description

  • Extract Signature Validation into new page

  • Extract Split Token into new page

  • Update menu with new JWT subpages

  • Keep JWT Overview concise


Diagram Walkthrough

flowchart LR
  overview["JWT Overview (existing)"]
  sig["Signature Validation (new page)"]
  split["Split Token (new page)"]
  menu["Site menu.yaml updated"]

  overview -- "content trimmed" --> sig
  overview -- "content trimmed" --> split
  menu -- "adds links" --> sig
  menu -- "adds links" --> split
Loading

File Walkthrough

Relevant files
Documentation
json-web-tokens.md
Split out signature and split-token content                           

tyk-docs/content/basic-config-and-security/security/authentication-authorization/json-web-tokens.md

  • Remove Signature Validation section and subsections
  • Remove JWKS caching, management, feature table
  • Remove Split Token Flow guide and examples
  • Retain Classic APIs note; page streamlined
+0/-309 
menu.yaml
Add new JWT docs to navigation                                                     

tyk-docs/data/menu.yaml

  • Add menu entry: Signature Validation page
  • Add menu entry: Split Token page
  • Keep existing JWT overview, claim validation, authorization
  • Ensure new routes under API Management > Authentication
+8/-0     

@github-actions
Copy link
Contributor

⚠️ Deploy preview for PR #7097 did not become live after 3 attempts.
Please check Netlify or try manually: Preview URL

@github-actions
Copy link
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Broken Links Risk

Large sections on signature validation and split token flow were removed from the overview; ensure corresponding new pages exist with correct slugs and that all inbound links within the docs are updated to the new locations.

### Using Tyk Classic APIs

As noted in the Tyk Classic API [documentation]({{< ref "api-management/gateway-config-tyk-classic#configuring-authentication-for-tyk-classic-apis" >}}), you can select JSON Web Token authentication using the `use_jwt` option. Tyk Classic APIs do not natively support multiple JWKS endpoints, though a [custom authentication plugin]({{< ref "api-management/plugins/plugin-types#authentication-plugins" >}}) could be used to implement this functionality.
Menu Path Consistency

New menu entries reference paths under /api-management/authentication/ which differ from the overview path; verify these routes resolve and match the new page locations and front matter aliases.

- title: "Signature Validation"
  path: /api-management/authentication/jwt-signature-validation
  category: Page
  show: True
Ordering/Grouping

The insertion points for “Signature Validation” and “Split Token” may affect logical reading order between Overview, Claim Validation, and Authorization; confirm desired ordering and grouping under JWT.

- title: "Split Token"
  path: /api-management/authentication/jwt-split-token
  category: Page
  show: True

@github-actions
Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Verify menu link target exists

Ensure the new path matches an existing or newly created page. If the page was split
from the removed section, verify redirects from the original URL and consistent
section placement to avoid broken links in navigation.

tyk-docs/data/menu.yaml [668-671]

+- title: "Signature Validation"
+  path: /api-management/authentication/jwt-signature-validation
+  category: Page
+  show: True
 
-
Suggestion importance[1-10]: 6

__

Why: Sensible navigation check to avoid broken links; matches the new hunk exactly but only requests verification, offering limited direct improvement.

Low
Prevent 404 from missing page

Confirm the new Split Token page exists and that any anchors or internal references
from the removed content are redirected. If the page is not yet added, hide the menu
item to prevent 404s.

tyk-docs/data/menu.yaml [680-683]

 - title: "Split Token"
   path: /api-management/authentication/jwt-split-token
   category: Page
-  show: True
+  show: False
Suggestion importance[1-10]: 6

__

Why: Prudent to hide the menu item if the new page isn't present, reducing 404 risk; the snippet matches the new hunk, though impact depends on page existence.

Low

@netlify
Copy link

netlify bot commented Oct 28, 2025

PS. Add to the end of url /docs/nightly

Name Link
🔨 Latest commit a5363b2
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/6900b5962c935e0008e4320b
😎 Deploy Preview https://deploy-preview-7097--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

1 similar comment
@netlify
Copy link

netlify bot commented Oct 28, 2025

PS. Add to the end of url /docs/nightly

Name Link
🔨 Latest commit a5363b2
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/6900b5962c935e0008e4320b
😎 Deploy Preview https://deploy-preview-7097--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Oct 28, 2025

PS. Add to the end of url /docs/nightly

Name Link
🔨 Latest commit 787a3ac
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/690ca88e6d2f9100083d6c12
😎 Deploy Preview https://deploy-preview-7097--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@sharadregoti sharadregoti changed the title Split json page Add Signature Validation & Split Token page Oct 29, 2025
@sharadregoti sharadregoti requested a review from Copilot October 29, 2025 11:28
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR restructures the JWT authentication documentation by splitting a large monolithic document into multiple focused pages, improving navigation and maintainability. The signature validation and split token sections have been extracted from the main JWT authentication page and converted into dedicated documentation pages.

Key changes:

  • Extracted JWT Signature Validation content into a new standalone page
  • Extracted JWT Split Token Flow content into a new standalone page
  • Added menu entries for the two new documentation pages
  • Updated descriptions for JWT Claim Validation and Authorization pages
  • Added FAQ sections to the JWT Claim Validation and Signature Validation pages

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tyk-docs/data/menu.yaml Added menu entries for "Signature Validation" and "Split Token" under JSON Web Tokens section
tyk-docs/content/basic-config-and-security/security/authentication-authorization/json-web-tokens.md Removed signature validation and split token sections (moved to dedicated pages)
tyk-docs/content/api-management/authentication/jwt-split-token.md New page containing JWT Split Token Flow documentation with enhanced Mermaid diagram
tyk-docs/content/api-management/authentication/jwt-signature-validation.md New page containing JWT Signature Validation documentation with FAQ section
tyk-docs/content/api-management/authentication/jwt-claim-validation.md Updated description and added FAQ section
tyk-docs/content/api-management/authentication/jwt-authorization.md Updated description for consistency

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@sharadregoti
Copy link
Contributor Author

This PR has been migrated to the new repository

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants