[TT-15909] Docs update for Graphql Playground.mdx #876

JoanCamosTyk · 2025-11-04T15:47:27Z

User description

Updating Documentation regarding the new Graphql Playground feature introduced in 1.15.0 Portal

PR Type

Documentation

Description

Add GraphQL Playground docs to portal
Specify availability from version 1.15.0
Explain playground capabilities and usage
Minor formatting fix at file end

Diagram Walkthrough

flowchart LR
  docs["Portal docs: API Products"] -- "new section" --> gql["GraphQL Playground overview"]
  gql -- "lists capabilities" --> caps["Browse schema, test queries, download schema"]
  gql -- "notes" --> ver["Available from Portal 1.15.0+"]

File Walkthrough

Relevant files

Documentation

api-products.mdx `Document GraphQL Playground feature in portal docs` portal/api-products.mdx Added new section: "GraphQL Playground in the Developer Portal". Included overview and feature list for the playground. Noted availability from Portal version 1.15.0+. Fixed end-of-file newline/formatting.	+15/-1

github-actions · 2025-11-04T15:48:25Z

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review Style/Clarity Consider rephrasing the sentence about availability and the overview to avoid redundancy and ensure consistent punctuation (e.g., add a period after the overview sentence and use consistent hyphenation like "GraphQL" and "API's" apostrophe). ### Overview The Tyk Enterprise Developer Portal now supports a fully integrated GraphQL Playground, allowing developers to explore and test GraphQL queries directly within the portal interface. This playground provides a powerful, interactive experience for working with GraphQL APIs Note: This feature is available from Portal version 1.15.0 and above. ### What is the GraphQL Playground? The GraphQL Playground is a developer tool embedded in the Enterprise Developer Portal. It enables developers to: - Browse the API’s schema and documentation - Test queries and mutations - Explore available types and fields - Download the GraphQL schema Formatting The "Note" could be formatted as a callout/admonition if the docs system supports it to improve visibility (e.g., Note/Info block for version requirement). Note: This feature is available from Portal version 1.15.0 and above.

github-actions · 2025-11-04T15:48:31Z

PR Code Suggestions ✨

No code suggestions found for the PR.

portal/api-products.mdx

sharadregoti

Can we add a screenshot showing exactly where the GraphQL Playground is in the developer portal? Showing the sidebar navigation and the tabs where this playground is present. The entire window snapshot is preferred.

caroltyk · 2025-11-11T14:39:11Z

portal/api-products.mdx


 These are the minimal steps to create an API Product and of course it won't be very appealling to API Consumers if you did publish it. You might want to select the Product's tile and add some description, documentation and user guides. Remember to select **Save Changes** when you are done.

+## GraphQL Playground in the Developer Portal


The original document introduces what API product is, and how to set it up section by section. The "GraphQL Playground in the Developer Portal" section breaks the flow and doesn't read natural to me. I don't think it is required on this page.

caroltyk · 2025-11-11T14:39:30Z

portal/api-products.mdx

- **Format**: Upload OpenAPI Description files in JSON or YAML format from file or URL
+- **Format**: Upload API specification files in multiple formats:
+    - OpenAPI: JSON or YAML format from file or URL
+    - GraphQL SDL: Schema Definition Language files (.graphql, .graphqls, or JSON format) from file or URL


How about other fields, like GraphQL server URL?

caroltyk · 2025-11-11T14:43:45Z

portal/api-products.mdx

+- Explore available types and fields
+- Download the GraphQL schema
+
+<img src="/img/portal/Portal-graphql-playground.png" alt="Portal GraphQL Playground" />


Summarize the playground feature briefly and move it to "Behavior in Live Portal".
We might add a note for the existing swagger screenshot, explaining that it is what OpenAPI documentation looks like.
We can add a note to explain GraphQL playground would be displayed for GraphQL API with SDL uploaded

The screen shot should show full screen, not just the playground.

github-actions bot added the Review effort 1/5 label Nov 4, 2025

mintlify bot deployed to staging November 4, 2025 15:51 View deployment

mintlify bot deployed to staging November 5, 2025 08:02 View deployment

JoanCamosTyk requested a review from caroltyk November 5, 2025 08:09

mintlify bot deployed to staging November 5, 2025 08:11 View deployment

mintlify bot deployed to staging November 5, 2025 08:20 View deployment

JoanCamosTyk requested a review from sharadregoti November 5, 2025 08:21

JoanCamosTyk added 4 commits November 6, 2025 15:36

[TT-15909] Docs update for Graphql Playground.mdx

02cdcdf

Update api-products.mdx

59317ad

Update api-products.mdx

f046566

Update api-products.mdx

6b541f7

sharadregoti force-pushed the JoanCamosTyk-patch-2 branch from f9a63ca to 6b541f7 Compare November 6, 2025 10:07

sharadregoti changed the base branch from production to main November 6, 2025 10:07

mintlify bot deployed to staging November 6, 2025 10:08 View deployment

sharadregoti added the documentation Improvements or additions to documentation label Nov 6, 2025

sharadregoti requested changes Nov 6, 2025

View reviewed changes

portal/api-products.mdx Outdated Show resolved Hide resolved

portal/api-products.mdx Show resolved Hide resolved

Update portal/api-products.mdx

125326f

buger mentioned this pull request Nov 6, 2025

🔄 Preview: [TT-15909] Docs update for Graphql Playground.mdx #885

Draft

Update portal/api-products.mdx

09d74d9

sharadregoti requested changes Nov 6, 2025

View reviewed changes

portal/api-products.mdx Show resolved Hide resolved

mintlify bot deployed to staging November 6, 2025 11:32 View deployment

Merge main into JoanCamosTyk-patch-2

989a795

mintlify bot deployed to staging November 6, 2025 13:04 View deployment

Merge main into JoanCamosTyk-patch-2

df7f2ea

mintlify bot deployed to staging November 7, 2025 05:45 View deployment

Update api-products.mdx

731b141

mintlify bot deployed to staging November 10, 2025 13:22 View deployment

Add files via upload

1593d33

mintlify bot deployed to staging November 10, 2025 13:26 View deployment

Delete img/portal/portal-graphql-playground.png

9b24a12

mintlify bot deployed to staging November 10, 2025 13:40 View deployment

Add files via upload

242ae9d

mintlify bot deployed to staging November 10, 2025 13:42 View deployment

Update api-products.mdx

2b03f8f

mintlify bot deployed to staging November 10, 2025 13:52 View deployment

Update api-products.mdx

6fc9e61

mintlify bot deployed to staging November 10, 2025 16:30 View deployment

Merge main into JoanCamosTyk-patch-2

1c03531

mintlify bot deployed to staging November 11, 2025 04:52 View deployment

Merge main into JoanCamosTyk-patch-2

b2bc321

mintlify bot deployed to staging November 11, 2025 05:02 View deployment

Merge main into JoanCamosTyk-patch-2

208c778

mintlify bot deployed to staging November 11, 2025 05:52 View deployment

sharadregoti requested changes Nov 11, 2025

View reviewed changes

Merge main into JoanCamosTyk-patch-2

9ffac03

mintlify bot deployed to staging November 11, 2025 10:31 View deployment

Merge main into JoanCamosTyk-patch-2

cabbb48

mintlify bot deployed to staging November 11, 2025 11:44 View deployment

buger added 2 commits November 11, 2025 15:17

Merge main into JoanCamosTyk-patch-2

c5ac221

Merge main into JoanCamosTyk-patch-2

6c56b60

mintlify bot deployed to staging November 11, 2025 12:21 View deployment

caroltyk requested changes Nov 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[TT-15909] Docs update for Graphql Playground.mdx #876

[TT-15909] Docs update for Graphql Playground.mdx #876

Uh oh!

JoanCamosTyk commented Nov 4, 2025 •

edited by github-actions bot

Loading

Uh oh!

github-actions bot commented Nov 4, 2025

Uh oh!

github-actions bot commented Nov 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sharadregoti left a comment

Uh oh!

caroltyk Nov 11, 2025

Uh oh!

caroltyk Nov 11, 2025

Uh oh!

caroltyk Nov 11, 2025

Uh oh!

caroltyk Nov 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants


		These are the minimal steps to create an API Product and of course it won't be very appealling to API Consumers if you did publish it. You might want to select the Product's tile and add some description, documentation and user guides. Remember to select Save Changes when you are done.

		## GraphQL Playground in the Developer Portal

[TT-15909] Docs update for Graphql Playground.mdx #876

Are you sure you want to change the base?

[TT-15909] Docs update for Graphql Playground.mdx #876

Uh oh!

Conversation

JoanCamosTyk commented Nov 4, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User description

PR Type

Description

Diagram Walkthrough

File Walkthrough

Uh oh!

github-actions bot commented Nov 4, 2025

PR Reviewer Guide 🔍

Uh oh!

github-actions bot commented Nov 4, 2025

PR Code Suggestions ✨

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sharadregoti left a comment

Choose a reason for hiding this comment

Uh oh!

caroltyk Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

caroltyk Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

caroltyk Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

caroltyk Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

JoanCamosTyk commented Nov 4, 2025 •

edited by github-actions bot

Loading