🤖 Auto-merge documentation from branches

[buger]

User description

📚 Documentation Merge Summary

This PR contains automatically merged documentation from multiple branches.

Triggered by:

• Branch: main
• Commit: d6023f1
• PR: [DX-2144] Fixed Swagger Docs #863 - Fixed Swagger Docs

Deployment Details:

• Generated from: branches-config.json
• Run ID: 19028590485
• Subfolder: (root deployment)
• Timestamp: $(date)

Changes Include:

• ✅ Merged documentation from multiple branches
• ✅ Generated unified docs.json configuration
• ✅ Updated assets and content structure
• ✅ Cleaned up outdated version folders

---

🚦 This PR will be processed by merge queue to ensure proper validation and ordering.

Previous deployment PRs have been automatically closed to prevent conflicts.

---

PR Type

Documentation

---

Description

• Add API overview MDX pages

• Update sidebar titles to "Overview"

• Link MD pages with OpenAPI specs

• Improve intros, auth guidance, images

---

Diagram Walkthrough

flowchart LR
  docsJSON["docs.json navigation"] -- "add overview pages" --> navGroups["Gateway/Dashboard/Admin/MDCB/EDP/AI Studio"]
  navGroups -- "link to MDX + OpenAPI" --> swaggerUX["Improved API docs UX"]

Loading

File Walkthrough

Relevant files

Documentation

7 files docs.json Add overview pages to API nav groups                                          +18/-0    ai-studio-swagger.mdx Add AI Studio API overview and sidebar                                      +2/-1      dashboard-admin-api.mdx Add intro, auth header, image; rename sidebar                        +14/-1    tyk-edp-api.mdx Add portal API intro, auth, image; retitle                              +18/-2    tyk-dashboard-api.mdx Add dashboard API overview, security, auth                              +31/-1    tyk-gateway-api.mdx Add gateway API overview, warnings, auth, images                  +25/-1    tyk-mdcb-api.mdx Add MDCB API description and sidebar label                              +5/-1

---

[buger]

🤖 Superseded by newer deployment (Run #375)

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ 863 - PR Code Verified Compliant requirements: Add overview pages for Swagger/OpenAPI-backed APIs (Gateway, Dashboard, Dashboard Admin, MDCB, EDP, AI Studio) Improve API descriptions and guidance/intros Update sidebar titles to "Overview" Link MD pages alongside OpenAPI specs in navigation (docs.json) Requires further human verification: Validate that all new image asset URLs resolve correctly in the built site Verify docs.json navigation renders expected groups and pages across environments Check canonical links map to correct live routes without duplicates or redirects

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Navigation Consistency Ensure added "pages" arrays coexist correctly with "openapi" entries in all groups and do not break existing sidebar behavior; confirm path casing and prefixes match the filesystem and route structure. "group": "Gateway", "pages": [ "nightly/tyk-gateway-api" ], "openapi": "swagger/nightly/gateway-swagger.yml" }, { "group": "Dashboard", "pages": [ "nightly/tyk-dashboard-api" ], "openapi": "swagger/nightly/dashboard-swagger.yml" }, { "group": "Dashboard Admin", "pages": [ "nightly/dashboard-admin-api" ], "openapi": "swagger/nightly/dashboard-admin-swagger.yml" }, { "group": "MDCB", "pages": [ "nightly/tyk-mdcb-api" ], "openapi": "swagger/nightly/mdcb-swagger.yml" }, Auth Header Formatting The authorization header is shown as a raw inline code string; confirm this matches the product's expected header name and casing across versions and that fenced block formatting renders as intended. In order to use the Dashboard API, you'll need to get the 'Tyk Dashboard API Access Credentials' secret from your user profile on the Dashboard UI. The secret you set should then be sent along as a header with each Dashboard API Request in order for it to be successful: `authorization: <your-secret>` Security Warning Clarity The warning advises not to expose the Gateway API; consider using an admonition component if supported to ensure visibility and consistent styling across the docs site. The Tyk Gateway API is the primary means for integrating your application with the Tyk API Gateway system. This API is very small, and has no granular permissions system. It is intended to be used purely for internal automation and integration. **Warning: Under no circumstances should outside parties be granted access to this API.** The Tyk Gateway API is capable of: * Managing session objects (key generation). * Managing and listing policies. * Managing and listing API Definitions (only when not using the Tyk Dashboard).

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Add accessible alt text Add descriptive alt text to images for accessibility and to prevent broken rendering in environments where images are blocked. This also improves SEO and screen-reader support. nightly/tyk-gateway-api.mdx [10-11] -<img src="https://tyk.io/docs/img/swagger_gateway_image.png" width="963" height="250"/> -<img src="https://tyk.io/docs/img/swagger_gateway_direction_image.png" width="946" height="392"/> +<img src="https://tyk.io/docs/img/swagger_gateway_image.png" width="963" height="250" alt="Tyk Gateway API overview banner"/> +<img src="https://tyk.io/docs/img/swagger_gateway_direction_image.png" width="946" height="392" alt="Diagram illustrating Gateway API direction and flow"/> Suggestion importance[1-10]: 6 __ Why: Adding alt attributes improves accessibility and SEO without changing functionality; the existing lines are present in the new hunk and the improved code accurately reflects the change.	Low
	Clarify header formatting Specify the header name exactly as used by the product and format as a single-line code block to avoid MDX processors treating it as a fenced block without language. Consistent casing reduces integration errors by users copying the snippet. nightly/dashboard-admin-api.mdx [17-19] -``` -admin-auth: <your-secret> -``` +`admin-auth: <your-secret>` Suggestion importance[1-10]: 5 __ Why: Converting the fenced block to inline code can reduce copy/paste ambiguity, but the benefit is minor and may reduce readability; the referenced code is present and the change is accurate.	Low
	Normalize key ordering Ensure the pages entry appears before or after openapi consistently across all groups if your docs parser relies on key order. Some JSON-to-UI pipelines are order-sensitive and may ignore openapi when unexpected keys precede it. docs.json [1679-1684] { "group": "Gateway", + "openapi": "swagger/nightly/gateway-swagger.yml", "pages": [ "nightly/tyk-gateway-api" - ], - "openapi": "swagger/nightly/gateway-swagger.yml" + ] } Suggestion importance[1-10]: 4 __ Why: The snippet exists in the new hunk and reordering keys could help if the consumer is order-sensitive, but JSON object key order is generally not semantically significant; impact is modest and somewhat speculative.	Low