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

Conversation

@buger
Copy link
Member

@buger buger commented Nov 3, 2025

User description

Add availablity section for enterprise upstream auth features (#7116)


PR Type

Documentation


Description

  • Add enterprise availability tables

  • Clarify enterprise-only upstream auth support

  • Fix OAuth capitalization consistency


Diagram Walkthrough

flowchart LR
  UA["Upstream authentication overview"]
  BA["Basic Auth doc"]
  OA["OAuth 2.0 doc"]
  AV["Availability tables (Enterprise)"]
  CAP["OAuth capitalization fix"]

  UA -- "note updated" --> CAP
  BA -- "add" --> AV
  OA -- "add" --> AV
Loading

File Walkthrough

Relevant files
Documentation
upstream-authentication.md
Fix OAuth capitalization in enterprise-only note                 

tyk-docs/content/api-management/upstream-authentication.md

  • Correct "Oauth" to "OAuth".
  • Preserve enterprise-only note wording.
+1/-1     
basic-auth.md
Add availability table for Basic Auth                                       

tyk-docs/content/api-management/upstream-authentication/basic-auth.md

  • Add "Availability" section.
  • Mark Gateway/Dashboard as Enterprise.
+5/-0     
oauth.md
Add availability table for OAuth 2.0                                         

tyk-docs/content/api-management/upstream-authentication/oauth.md

  • Add "Availability" section.
  • Mark Gateway/Dashboard as Enterprise.
+6/-0     

@buger buger enabled auto-merge (squash) November 3, 2025 11:54
@github-actions
Copy link
Contributor

github-actions bot commented Nov 3, 2025

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

@github-actions
Copy link
Contributor

github-actions bot commented Nov 3, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Clarify enterprise-only availability

Clarify that availability is limited to Enterprise editions to avoid ambiguity about
"licensed users." This ensures consistency with the new availability tables in
related pages.

tyk-docs/content/api-management/upstream-authentication.md [34]

-Upstream Basic Authentication and OAuth 2.0 support are only available to licensed users, via the Tyk Dashboard. These features are not available to open source users.
+Upstream Basic Authentication and OAuth 2.0 support are only available in Enterprise editions via the Tyk Dashboard. These features are not available to open source users.
Suggestion importance[1-10]: 6

__

Why: The existing line 34 matches and the change improves clarity by aligning with related pages' availability tables; it's a minor content refinement, not a bug fix.

Low
Use precise edition naming

Specify the exact product/edition naming consistently to prevent misinterpretation.
If "Enterprise (Self-Managed and Cloud)" is the official term, reflect it to align
with other docs.

tyk-docs/content/api-management/upstream-authentication/basic-auth.md [12-16]

 ## Availability 
 
-| Component   | Editions   |
-| ----------- | ---------- |
-| Gateway and Dashboard | Enterprise |
+| Component             | Editions                         |
+|-----------------------|----------------------------------|
+| Gateway and Dashboard | Enterprise (Self-Managed, Cloud) |
Suggestion importance[1-10]: 5

__

Why: The snippet exactly matches lines 12-16 and the proposed wording could enhance consistency; impact is moderate and depends on official nomenclature.

Low
Align availability phrasing

Mirror the availability wording with the basic auth page to maintain consistency and
reduce confusion across pages. Use the same edition phrasing if applicable.

tyk-docs/content/api-management/upstream-authentication/oauth.md [12-16]

 ## Availability 
 
-| Component   | Editions   |
-| ----------- | ---------- |
-| Gateway and Dashboard | Enterprise |
+| Component             | Editions                         |
+|-----------------------|----------------------------------|
+| Gateway and Dashboard | Enterprise (Self-Managed, Cloud) |
Suggestion importance[1-10]: 5

__

Why: Lines 12-16 match; mirroring phrasing across pages aids consistency, though it’s a stylistic/content alignment rather than a functional correction.

Low

@netlify
Copy link

netlify bot commented Nov 3, 2025

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

Name Link
🔨 Latest commit 21ce91c
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/690897fd0e10d0000823fb5f
😎 Deploy Preview https://deploy-preview-7117--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 disabled auto-merge November 4, 2025 04:55
@sharadregoti sharadregoti merged commit ae79ac6 into release-5.10 Nov 4, 2025
11 of 12 checks passed
@sharadregoti sharadregoti deleted the merge/release-5.10/f78203cb2a6c725805d14ae23325b59a28e6b712 branch November 4, 2025 04:55
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants