GraphqlQuery.Native (graphql_query v0.6.2)

View Source

Native interface to Rust functions for GraphQL query validation and formatting.

Summary

Functions

Parses a GraphQL document and returns information about it. Returns {:ok, GraphqlQuery.DocumentInfo.t()} or {:error, [GraphqlQuery.ValidationError.t()]}

Formats a GraphQL query string. Returns {:ok, formatted_query} or {:error, reason}.

Formats a GraphQL schema string. Returns {:ok, formatted_schema} or {:error, reason}.

Validates and formats a GraphQL query string in one call. Returns {:ok, {validated_query, formatted_query}} or {:error, reason}.

Validates a GraphQL fragment string with a document path and optional schema information. Returns {:ok, [GraphqlQuery.ValidationWarning.t()]} if valid (with any deprecation warnings), or {:error, [GraphqlQuery.ValidationError.t()]} if invalid with detailed error messages.

Validates a GraphQL query string with a document path and optional schema information. Returns {:ok, [GraphqlQuery.ValidationWarning.t()]} if valid (with any deprecation warnings), or {:error, [GraphqlQuery.ValidationError.t()]} if invalid with detailed error messages.

Validates a GraphQL schema string with a document path. Returns {:ok, [GraphqlQuery.ValidationWarning.t()]} if valid (with any deprecation warnings), or {:error, [GraphqlQuery.ValidationError.t()]} if invalid with detailed error messages.

Functions

document_information(document, path)

Parses a GraphQL document and returns information about it. Returns {:ok, GraphqlQuery.DocumentInfo.t()} or {:error, [GraphqlQuery.ValidationError.t()]}

format_query(query)

Formats a GraphQL query string. Returns {:ok, formatted_query} or {:error, reason}.

format_schema(query)

Formats a GraphQL schema string. Returns {:ok, formatted_schema} or {:error, reason}.

validate_and_format_query(query)

Validates and formats a GraphQL query string in one call. Returns {:ok, {validated_query, formatted_query}} or {:error, reason}.

validate_fragment(fragment, path, schema_info \\ nil)

Validates a GraphQL fragment string with a document path and optional schema information. Returns {:ok, [GraphqlQuery.ValidationWarning.t()]} if valid (with any deprecation warnings), or {:error, [GraphqlQuery.ValidationError.t()]} if invalid with detailed error messages.

validate_query(query, path, schema_info \\ nil)

Validates a GraphQL query string with a document path and optional schema information. Returns {:ok, [GraphqlQuery.ValidationWarning.t()]} if valid (with any deprecation warnings), or {:error, [GraphqlQuery.ValidationError.t()]} if invalid with detailed error messages.

validate_schema(schema, path, federation \\ false)

Validates a GraphQL schema string with a document path. Returns {:ok, [GraphqlQuery.ValidationWarning.t()]} if valid (with any deprecation warnings), or {:error, [GraphqlQuery.ValidationError.t()]} if invalid with detailed error messages.