search

cirruslabs / cirrus-ci-docs

Documentation for Cirrus CI 📚
https://cirrus-ci.org
MIT License
350 stars 109 forks source link

Document GraphQL Subscriptions #464

Open AstraLuma opened 4 years ago

AstraLuma commented 4 years ago

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?

fkorotkov commented 4 years ago

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?

AstraLuma commented 4 years ago

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.

AstraLuma commented 4 years ago

Actually, the regular HTTP API isn't actually documented either.

AstraLuma commented 4 years ago

(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.)