search

cylc / cylc-doc

Documentation (User Guide, Cheat Sheets, etc.) for the Cylc Workflow Engine.
https://cylc.github.io/cylc-doc/
GNU General Public License v3.0
9 stars 19 forks source link

document graphql schema #80

Open kinow opened 5 years ago

kinow commented 5 years ago

For API consumers , GraphiQL is a must. But having a diagram for quickly understanding how entities relate to each other may be helpful too.

Here's one generated with https://github.com/APIs-guru/graphql-voyager and the introspection query.

cylc-graphql svg

And source, which was generated by cutting the SVG from GraphQL Voyager canvas, then pasting into a file, and editing with Inkspace.

cylc-graphql.svg.zip

Ideally we would have an automated way to generate it, as with the database schema.

kinow commented 5 years ago

Low priority, probably for after 8.0 release.

oliver-sanders commented 2 years ago

Now that we have graphiql installed in the UIS the need for this is less (graphiql has a docs panel which allows us to explore the schema docs interactively). We should add a note to the docs explaining this.