Skip to content

Commit e798ce1

Browse files
committed
docs: apply review learnings to graphql-playground.mdx
- Remove em dashes from step 1 sub-bullets (no-em-dash rule) - Add TODO screenshot placeholder after step 3 (APIs tab) - Link "Product Catalogues" in step 8 to manage-catalogues page - Link "Developer App" in credential injection section
1 parent 563371b commit e798ce1

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

tyk-developer-portal/graphql-playground.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ You can add a GraphQL Schema Definition Language (SDL) file to an API Product to
3232

3333
If you don't have an existing GraphQL API, use the built-in Star Wars example from the Tyk Dashboard:
3434
- Navigate to **APIs > Add New API**, click **Try example**, select **Star Wars GQL API**, and click **Use Example**
35-
- Copy the **Key ID** from the confirmation pop-up and save it you will use this as the auth header when testing in the Playground
36-
- Go to the **Schema** tab of the newly created API and download the schema file you will upload this as the SDL file in step 5
35+
- Copy the **Key ID** from the confirmation pop-up and save it; you will use this as the auth header when testing in the Playground
36+
- Go to the **Schema** tab of the newly created API and download the schema file; you will upload this as the SDL file in step 5
3737

3838
<img src="/img/graphql-api-star-wars-schema.png" alt="GraphQL API Schema Tab" />
3939

@@ -44,6 +44,8 @@ You can add a GraphQL Schema Definition Language (SDL) file to an API Product to
4444
- **Choose authentication method**: match the authentication configured on your GraphQL API
4545
- **Select APIs**: check your GraphQL API from the list
4646

47+
{/* TODO: Screenshot — APIs tab showing a GraphQL API selected, with provider and authentication method dropdowns populated */}
48+
4749
4. Go to the **Documentation** tab and click **Add API specification**.
4850

4951
5. Set the specification type to **GraphQL SDL**, then upload your schema file.
@@ -62,7 +64,7 @@ You can add a GraphQL Schema Definition Language (SDL) file to an API Product to
6264

6365
7. Click **Save Changes**.
6466

65-
8. Open your **Live Portal**, go to **Product Catalogues**, locate the product, and click **Docs**.
67+
8. Open your **Live Portal**, go to [**Product Catalogues**](/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/manage-catalogues), locate the product, and click **Docs**.
6668

6769
<img src="/img/graphql-docs-live-portal.png" alt="GraphQL API Docs Live Portal" />
6870

@@ -114,7 +116,7 @@ From v1.16.0, [Universal Data Graph (UDG)](/api-management/graphql/universal-dat
114116

115117
## Credential Injection in the Playground
116118

117-
When a consumer's Developer App has been approved to access a Product, their credentials are automatically pre-populated in the Playground's HTTP headers. No additional configuration is required.
119+
When a consumer's [Developer App](/portal/developer-app) has been approved to access a Product, their credentials are automatically pre-populated in the Playground's HTTP headers. No additional configuration is required.
118120

119121
The header format matches the authentication scheme of the APIs in the Product. For example, for an Auth Token API the Playground injects:
120122

0 commit comments

Comments
 (0)