[TT-13475] Update documentation for master

[buger]

User description

Triggered by: lghiur

Included:

Tyk Gateway: true
Tyk Dashboard: true
Tyk MDCB false
Tyk Pump false

Intended for: master
Changes sourced from: release-5.7.0
Config info generator branch: main

Note: Docs update for 5.7.0 (branch suffix: docs)

JIRA: https://tyktech.atlassian.net/browse/TT-13475

---

PR Type

Documentation, Enhancement

---

Description

• Updated the Tyk Dashboard and Gateway API documentation to version 5.7.0, including new endpoints for managing Streams API.
• Added detailed configuration documentation for new features such as trial settings, audit log storage options, and streaming configurations.
• Introduced upstream authentication configurations, including basic and OAuth2 authentication methods.
• Provided deprecation notices for OIDC and ExternalOAuth, recommending the use of JWT instead.

---

Changes walkthrough 📝

Relevant files

Documentation

dashboard-swagger.yml Update Dashboard Swagger for Streams API and Version 5.7.0 tyk-docs/assets/others/dashboard-swagger.yml Updated API version from 5.6.0 to 5.7.0. Added new endpoints for managing Streams API. Updated schema references to Tyk's master branch. Introduced example for Streams API. +512/-9  gateway-swagger.yml Update Gateway Swagger to Version 5.7.0                                    tyk-docs/assets/others/gateway-swagger.yml Updated API version from 5.6.0 to 5.7.0. +1/-1      dashboard-config.md Add New Configuration Settings for Dashboard                          tyk-docs/content/shared/dashboard-config.md Added new configuration sections for trial and audit settings. Introduced streaming and labs configuration settings. Added disable telemetry configuration. +58/-0    x-tyk-gateway.md Document Upstream Authentication and Deprecation Notices  tyk-docs/content/shared/x-tyk-gateway.md Added upstream authentication configuration details. Introduced deprecation notices for OIDC and ExternalOAuth. Added new fields for OAuth2 client credentials and password authentication. +125/-14

---

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

[netlify]

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

Name	Link
🔨 Latest commit	ee24cb4
🔍 Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/673c56346d99f20008f764a7
😎 Deploy Preview	https://deploy-preview-5733--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review API Schema References The PR changes the schema references from a general OpenAPI Specification to a Tyk-specific schema. This change should be validated to ensure that it does not break any existing functionality or integrations that rely on the standard OpenAPI schema. New API Endpoints New endpoints for managing Streams API are introduced. It's crucial to ensure that these endpoints are secure, especially since they involve significant operations like creating, updating, and deleting API definitions. Response Schema Validation The response schemas for new endpoints should be thoroughly reviewed to ensure they meet the expected standards and contain all necessary error handling and metadata. Configuration Documentation New configuration options related to trial settings, audit log storage, and streaming configurations are added. These should be checked for accuracy and completeness in their descriptions and environmental variable mappings. Upstream Authentication Documentation for upstream authentication methods including basic and OAuth2 is added. It's important to verify that the described configurations and examples align with the actual implementation and security best practices.

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.