Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DX-1774, TT-13333] Upstream #5746

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[DX-1774, TT-13333] Upstream #5746

wants to merge 1 commit into from

Conversation

andyo-tyk
Copy link
Contributor

@andyo-tyk andyo-tyk commented Nov 22, 2024

User description

Preview Link

https://deploy-preview-5746--tyk-docs.netlify.app/docs/nightly/basic-config-and-security/security/upstream-authentication/

Description

Upstream authentication


PR Type

Documentation


Description

  • Added a new documentation page on upstream authentication, detailing various methods such as Mutual TLS, Token-based authentication, Basic Authentication, and OAuth 2.0.
  • Provided configuration examples for setting up upstream authentication in Tyk OAS API definitions.
  • Updated the documentation menu to include a new entry for "Upstream Authentication" and made title adjustments for consistency.

Changes walkthrough 📝

Relevant files
Documentation
upstream-authentication.md
Add detailed upstream authentication documentation             

tyk-docs/content/basic-config-and-security/security/upstream-authentication.md

  • Added comprehensive documentation on upstream authentication methods.
  • Included sections on Mutual TLS, Token-based authentication, Basic
    Authentication, and OAuth 2.0.
  • Provided configuration examples for Tyk OAS API definitions.
  • Explained usage of Tyk API Designer for setting up upstream
    authentication.
  • +437/-0 
    menu.yaml
    Update menu structure for upstream authentication               

    tyk-docs/data/menu.yaml

  • Updated menu titles for consistency (e.g., "MTLS" to "Mutual TLS").
  • Added new menu entry for "Upstream Authentication".
  • Adjusted capitalization for "Authentication and Authorization".
  • +11/-3   

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 Security concerns

    OAuth 2.0 Password Grant Usage:
    The use of OAuth 2.0 Password Grant is mentioned as supported for legacy systems, despite being discouraged in security best practices. This could potentially expose sensitive user credentials if not handled with extreme caution.

    ⚡ Recommended focus areas for review

    Documentation Clarity
    The documentation should clarify the use of deprecated or discouraged security practices, such as the OAuth 2.0 Password Grant, and provide clear warnings or alternatives.

    Link Validation
    Ensure all internal and external links are valid and lead to the correct resources. This includes checking for correct URL formatting and verifying that all referenced documents exist and are accessible.

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Nov 22, 2024

    PS. Pls add /docs/nightly to the end of url

    Name Link
    🔨 Latest commit 3a035d3
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/674067e1f9555200087f047c
    😎 Deploy Preview https://deploy-preview-5746--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 site configuration.

    1 similar comment
    Copy link

    netlify bot commented Nov 22, 2024

    PS. Pls add /docs/nightly to the end of url

    Name Link
    🔨 Latest commit 3a035d3
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/674067e1f9555200087f047c
    😎 Deploy Preview https://deploy-preview-5746--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 site configuration.

    @andyo-tyk andyo-tyk changed the title [DX-, TT-13333] Upstream [DX-1774, TT-13333] Upstream Nov 22, 2024
    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.

    1 participant