docs: added docs on how test graphql queries by TBThomas56 · Pull Request #1034 · DiamondLightSource/workflows

TBThomas56 · 2025-11-07T15:19:51Z

No description provided.

NatLeung96 · 2025-11-12T11:14:26Z

docs/how-tos/run-graphql-query.md

+## Exploring the Schema
+
+Click the *Docs* button (top-left) to browse the schema.
+Alternatively, use Ctrl - Space inside the query editor to view available fields an options.


Suggested change

Alternatively, use Ctrl - Space inside the query editor to view available fields an options.

Alternatively, use Ctrl + Space inside the query editor to view available fields and options.

I might be being too picky

NatLeung96

Is it worth explaining how to correctly provide variables or is that dumbing things down too much?

NatLeung96 · 2025-11-12T11:16:13Z

docs/how-tos/run-graphql-query.md

+## Exploring the Schema
+
+Click the *Docs* button (top-left) to browse the schema.
+Alternatively, use Ctrl - Space inside the query editor to view available fields an options.


I might be being too picky

TBThomas56 · 2025-11-12T13:46:05Z

Is it worth explaining how to correctly provide variables or is that dumbing things down too much?

would say that I can describe it, but how to write a query is a bit hard.

VictoriaBeilsten-Edmands · 2025-11-12T14:19:31Z

Is it worth explaining how to correctly provide variables or is that dumbing things down too much?

That would be helpful to add.

VictoriaBeilsten-Edmands · 2025-11-12T15:32:51Z

docs/how-tos/run-graphql-query.md

+
+There are alternative clients that can be used such as [*Postman*.](https://www.postman.com/)
+When configuring authorization for these tools:
+- store any sensitive data (passwords, tokens) securley as variables


VictoriaBeilsten-Edmands · 2025-11-12T15:33:18Z

docs/how-tos/run-graphql-query.md

+For more information on how to use the GraphQL Dashboard please have a look at the official
+GraphiQL docs [here](https://github.com/graphql/graphiql)
+
+## Alternative Clients


I suggest removing this section

VictoriaBeilsten-Edmands · 2025-11-12T15:33:46Z

docs/how-tos/run-graphql-query.md

@@ -0,0 +1,85 @@
+# How to Run A GraphQL Query
+
+This guide explains how to run a GRAPHQL query for workflows using the Workflows


Suggested change

This guide explains how to run a GRAPHQL query for workflows using the Workflows

This guide explains how to run a GraphQL query for workflows using the Workflows

VictoriaBeilsten-Edmands · 2025-11-12T15:34:25Z

docs/how-tos/run-graphql-query.md

+## The Dashboard
+
+The Workflows Dashboard includes a built-in GraphiQL client for writing and testing queries against
+the GRAPHQL endppoint.


Suggested change

the GRAPHQL endppoint.

the GraphQL endpoint.

VictoriaBeilsten-Edmands · 2025-11-12T15:36:10Z

docs/how-tos/run-graphql-query.md

+The Workflows Dashboard includes a built-in GraphiQL client for writing and testing queries against
+the GRAPHQL endppoint.
+
+### iGraphQL Client


VictoriaBeilsten-Edmands · 2025-11-12T15:36:36Z

docs/how-tos/run-graphql-query.md

+
+Click the *Docs* button (top-left) to browse the schema.
+The schema gives you an overview of available variables and their required types and helps build
+your query as a query, mutation or subscription.


Suggested change

your query as a query, mutation or subscription.

your query, mutation or subscription.

VictoriaBeilsten-Edmands · 2025-11-12T15:39:05Z

docs/how-tos/run-graphql-query.md

+      node {
+        name
+        maintainer<F6>
+        suite


Suggested change

suite

title

VictoriaBeilsten-Edmands · 2025-11-12T15:39:12Z

docs/how-tos/run-graphql-query.md

+    edges {
+      node {
+        name
+        maintainer<F6>


Suggested change

maintainer<F6>

maintainer

VictoriaBeilsten-Edmands · 2025-11-12T15:40:19Z

docs/how-tos/run-graphql-query.md

+
+```
+query WorkflowTemplates {
+  workflowTemplates(limit: 4) {


Would it make more sense here to return nodes from the query as that's how we're currently using it

VictoriaBeilsten-Edmands · 2025-11-12T15:40:57Z

docs/how-tos/run-graphql-query.md

+
+### Obtaining a Token
+Run the following command to get a token in with the correct client id.
+Please take attention to which oidc-client-id you are using.


pay attention/ take care

VictoriaBeilsten-Edmands · 2025-11-12T15:41:58Z

docs/how-tos/run-graphql-query.md

+
+All queries require an *authentication token* in the request headers.
+
+Add the following header:


Add a screenshot to show where the header goes.

davehadley · 2025-11-12T15:48:33Z

docs/how-tos/run-graphql-query.md

+the GraphQL endpoint which is shown below.
+
+## Available Endpoints
+[Production](https://workflows.diamond.ac.uk/graphql)


Is this user-facing documentation or internal documentation for Workflows developers?

Assuming that it is user-facing, should we be encouraging them to use the Workflows endpoints directly? Is it not better to encourage them to use the federated graph?

Does general graph-QL documentation and tips belong here? Or is it better somewhere else like the Dev Portal?

TBThomas56 requested review from JamesDoingStuff, NatLeung96, VictoriaBeilsten-Edmands and davehadley November 7, 2025 15:19

github-actions bot assigned TBThomas56 Nov 7, 2025

TBThomas56 force-pushed the tbt/docs/graphql-queries branch from cdee3f6 to 067acf8 Compare November 12, 2025 11:06

NatLeung96 reviewed Nov 12, 2025

View reviewed changes

NatLeung96 requested changes Nov 12, 2025

View reviewed changes

TBThomas56 force-pushed the tbt/docs/graphql-queries branch from 067acf8 to beb8f83 Compare November 12, 2025 13:45

docs: added docs on how test graphql queries

eafc8b3

TBThomas56 force-pushed the tbt/docs/graphql-queries branch from beb8f83 to eafc8b3 Compare November 12, 2025 13:46

TBThomas56 requested a review from NatLeung96 November 12, 2025 13:46

NatLeung96 approved these changes Nov 12, 2025

View reviewed changes

NatLeung96 self-requested a review November 12, 2025 14:28

VictoriaBeilsten-Edmands reviewed Nov 12, 2025

View reviewed changes

VictoriaBeilsten-Edmands requested changes Nov 12, 2025

View reviewed changes

davehadley reviewed Nov 12, 2025

View reviewed changes

	Alternatively, use Ctrl - Space inside the query editor to view available fields an options.
	Alternatively, use Ctrl + Space inside the query editor to view available fields and options.

		@@ -0,0 +1,85 @@
		# How to Run A GraphQL Query

		This guide explains how to run a GRAPHQL query for workflows using the Workflows

	your query as a query, mutation or subscription.
	your query, mutation or subscription.


		All queries require an authentication token in the request headers.

		Add the following header:

Conversation

TBThomas56 commented Nov 7, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NatLeung96 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TBThomas56 commented Nov 12, 2025

Uh oh!

VictoriaBeilsten-Edmands commented Nov 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants