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

[TT-13475] Update documentation for master #5733

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

Conversation

buger
Copy link
Member

@buger buger commented Nov 19, 2024

Triggered by: sredxny

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: Update 5.7.0 docs (branch suffix: docs)

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

Copy link

netlify bot commented Nov 19, 2024

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

Name Link
🔨 Latest commit 3af3223
🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/673dddfa66999300084f9117
😎 Deploy Preview https://deploy-preview-5733--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.

Copy link
Contributor

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.

Copy link
Contributor

PR Code Suggestions ✨

No code suggestions found for the PR.

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.

4 participants