onegraph / graphql-codex Goto Github PK

Looking at https://www.onegraph.com/schema/example/GitHubMergePullRequest, it has variables hard-coded in the description. They're not formatted great, and they don't transfer to the try in GraphiQL link.

If graphql-codex supports (ideally commented) json variables in the frontmatter, it can render them nicely and include them in the try it links!

In the frontmatter, it'd be nice to be able to provide a list of example ids that are related to the current example so they could be rendered as links. There are quite a few mutations involved in creating a PR workflow on GitHub, and it'd be nice to list them as related to make discovery a bit easier.

Please add GraphQL Lists (Arrays) here:

(Or second-level fields, in the case of OneGraph.)

I had the impulse to click "base", wanting GraphiQL to open up with a base query. Currently the only GraphiQL links I'm finding are below examples.

On https://www.onegraph.com/schema/example/GitHubGetPullRequest the link for Add a comment to a Pull Request as a related example erroneously pointed to GitHubAddPullRequestCommentMutation instead of GitHubAddPullRequestComment.

It would be nice to be able to have a uri structure that explicitly linked to other examples in the markdown transform, e.g. examples://GitHubAddPullRequestComment. Then they could be extracted and transformed into the right links, and possibly even fail the build if they link to a missing example (that's not a great user experience).

It'd probably be a good idea to alphabetize the examples on e.g. https://www.onegraph.com/schema/object/Query so there's at least a known stable sorting order.