🤖 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: e5a254e
• PR: [DX-2170] Graphql Playground Guide #1012 - DX-2170 Graphql Playground Guide

Deployment Details:

• Generated from: branches-config.json
• Run ID: 19693048288
• 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 GraphQL Playground how-to guide

• Link guide in docs sidebar navigation

• Include prerequisites and setup steps

• Add troubleshooting and CORS guidance

---

Diagram Walkthrough

flowchart LR
  docs["docs.json navigation"] -- "add Guides > graphql-playground" --> sidebar["Portal docs sidebar"]
  guide["graphql-playground.mdx"] -- "how-to + troubleshooting" --> users["Portal users configure Playground"]

Loading

File Walkthrough

Relevant files

Documentation

docs.json Add GraphQL Playground to docs navigation                                docs.json Add Guides subgroup under Consuming APIs. Link nightly/tyk-developer-portal/graphql-playground. Extend portal navigation structure. +7/-1      event-driven-apis.mdx Correct self-managed trial link formatting                              nightly/api-management/event-driven-apis.mdx Fix link for self-managed trial in prerequisites. Correct website link formatting. +1/-1      graphql-playground.mdx New GraphQL Playground setup guide                                              nightly/tyk-developer-portal/graphql-playground.mdx New guide: set up GraphQL Playground. Provide prerequisites and version availability. Step-by-step API, product, docs configuration. Include troubleshooting (404, CORS) and headers. +139/-0

---

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ 1012 - PR Code Verified Compliant requirements: Add a GraphQL Playground setup guide. Link the guide in the docs navigation. Provide step-by-step configuration instructions. Include prerequisites and publishing steps. Requires further human verification: Validate links, images, and anchors resolve correctly in the built docs. Verify docs.json navigation renders the "Guides" group and the page under Consuming APIs in the Portal sidebar. Confirm GraphQL Playground renders and functions as described (browser test).

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Navigation Structure Adding a nested "Guides" group under "Consuming APIs" changes sidebar structure; confirm this grouping is intended and consistent with existing IA and that the new approve-requests page remains correctly ordered. "nightly/tyk-stack/tyk-developer-portal/enterprise-developer-portal/api-access/approve-requests", { "group": "Guides", "pages": [ "nightly/tyk-developer-portal/graphql-playground" ] } Link and Anchor Validity Several internal anchors (e.g., step references like /nightly/#1-create-a-graphql-api and catalogue link with colon) may not resolve; verify anchors and paths are correct for site build. - Publish API product to catalogue: Select the catalog you created [previously](/nightly/#2-create-the-api-catalog) - You can leave the other fields empty for now 4. On the **APIs** tab, select the `Star Wars GQL API` created in the [first step](/nightly/#1-create-a-graphql-api): 5. On the **Documentation** tab: - Add your **GraphQL API endpoint URL** (e.g `http://localhost:8080/star-wars-api/`). <Note> You can find the endpoint URL in the **Core Settings** tab of your GraphQL API in the Dashboard. </Note> - Upload a GraphQL SDL file (in .graphql, .graphqls, .gql, or JSON format) <Note> By default, the GraphQL playground will introspect the schema from the endpoint if no SDL file is provided. However, if the API is protected, introspection will not work, and the schema will be rendered from the uploaded SDL file. </Note> CORS Example Scope The CORS JSON snippet omits methods list; consider including typical allowed_methods or clarifying defaults to prevent confusion for readers. ```json "CORS": { "enable": true, "max_age": 24, "allow_credentials": true, "exposed_headers": [ "*" ], "allowed_headers": [ "*" ], "options_passthrough": true, "debug": false, "allowed_origins": [ "http://localhost:3001" ], "allowed_methods": [] }, </details> </td></tr> </table>

[buger]

🤖 Superseded by newer deployment (Run #449)

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Avoid mixed-type pages array The pages array mixes string entries with a nested group object, which may break consumers expecting homogeneous page paths. Move the "Guides" group out to the same level as its siblings, or ensure the schema supports nested groups here. This prevents JSON schema/runtime parsing errors in nav rendering. docs.json [1158-1167] "pages": [ "nightly/portal/developer-app", - "nightly/tyk-stack/tyk-developer-portal/enterprise-developer-portal/api-access/approve-requests", - { - "group": "Guides", - "pages": [ - "nightly/tyk-developer-portal/graphql-playground" - ] - } + "nightly/tyk-stack/tyk-developer-portal/enterprise-developer-portal/api-access/approve-requests" ] Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies that the pages array mixes strings and an object at lines 1159-1166, which can break consumers expecting homogeneous entries; proposed change is plausible and improves schema consistency.	Medium
General	Clarify trailing slash requirement The example endpoint includes a trailing slash; later troubleshooting relies on this. Explicitly warn that omitting it causes 404s to prevent user error. Add a short line in the note for clarity and consistency with the Troubleshooting section. nightly/tyk-developer-portal/graphql-playground.mdx [57-62] -- Add your **GraphQL API endpoint URL** (e.g `http://localhost:8080/star-wars-api/`). +- Add your **GraphQL API endpoint URL** (e.g., `http://localhost:8080/star-wars-api/`). <Note> - You can find the endpoint URL in the **Core Settings** tab of your GraphQL API in the Dashboard. + You can find the endpoint URL in the **Core Settings** tab of your GraphQL API in the Dashboard. Ensure the URL ends with a trailing slash (/) to avoid 404 errors in the Playground. </Note> Suggestion importance[1-10]: 7 __ Why: This adds a clear warning aligned with the troubleshooting note to prevent 404s; it’s accurate and improves UX, though it’s a documentation refinement rather than a critical bug fix.	Medium
	Fix broken in-page anchor The anchor slug includes a colon which many MDX/Docs routers strip or encode, likely breaking the deep link. Replace the fragment with the actual generated heading id (without punctuation) or link to the section without the colon to ensure navigation works. nightly/tyk-developer-portal/graphql-playground.mdx [43] -The Tyk Getting Started Guide creates an API Catalog (`Public catalogue`) by default. If you don't have one, refer to this [guide](/nightly/portal/publish-api-catalog#step-1:-create-the-api-catalog) to create an API Catalog in the Developer Portal. +The Tyk Getting Started Guide creates an API Catalog (`Public catalogue`) by default. If you don't have one, refer to this [guide](/nightly/portal/publish-api-catalog#step-1-create-the-api-catalog) to create an API Catalog in the Developer Portal. Suggestion importance[1-10]: 6 __ Why: The link fragment likely shouldn't contain a colon; adjusting to a hyphenated anchor is a reasonable, low-risk fix that improves navigation reliability, though not critical.	Low