GraphQL API

Every block below is compared character by character with the source files named above. If they drift apart, the documentation build fails.

Verified source excerpts

directive @alias(path: [String!]!) on FIELD_DEFINITION

export function createGraphQLBinding({

The schema is the source of truth for every query and mutation name, argument, result shape, and scalar. Generate your client types from it. Copying a query out of a blog post whose version you don’t know is how you find out at runtime that a field was renamed.

Binding

createGraphQLBinding({ url, ...config }) from the SDK. The client is created lazily.

Put credentials in lazy headers or host configuration. They must not reach workflow state, where they would be written into an event and stay there.

Authorization boundary

A GraphQL result is filtered by authorization before filters, ordering, paging, counts, or nested reads run. You cannot page or sort your way to something you may not see.

When the result is going into an audit record, keep the receipt with it. See Authorization — and note that authorization is preview in this release.