Conventions
How mutations return data, and how subscriptions stream it, across the whole schema.
Two patterns repeat across every domain in this reference, worth reading once instead of re-explained on every page.
Return shapes
A mutation returns the affected entity where natural, so a client needs no
second fetch. It returns Boolean for deletes and toggles, and a String
for reveal-secret operations, revealConnection and
rotateDatabasePassword both return the connection string.
A verdict is a return value, not an error
Where a mutation asks another system whether something works, the answer comes back in the payload and a failure resolves normally. A client that treats "the request succeeded" as "the thing it tested actually works" will report success over a check that just failed. See Backup destinations for the concrete example.
Subscriptions
Server-Sent Events, via graphql-yoga, not WebSockets. Each subscription
emits the entity on every state change: an initial snapshot, then live
updates, so a client tracks state with no polling. appStatus and
databaseStatus are the two subscriptions in the schema today, see
Apps and Databases.
See also
Did this page help you?