cirrus-ci-docs
cirrus-ci-docs copied to clipboard
Document GraphQL Subscriptions
Your GraphQL schema includes subscriptions, but the API docs don't mention how subscriptions are handled.
The GraphQL specification deliberately leaves out specific transport details.
How is this handled?
Will improve the documentation. In the meantime you can take a look at the sources of handling the subscription here. It's a bit complicated at the moment. What for do you want to use it?
Honestly, there's way too much going on in that file. I would just have to set up to just run a query and see what happens.
Actually, the regular HTTP API isn't actually documented either.
(Like, it's not documented in the sense that "We expect you to POST
an application/json
with the fields query
(String) and variables
(map), and you'll get back an application/json
with the fields errors
and data
.)