Reference

GraphQL schema conventions, query arguments, edge traversal structure, special fields, and the JSON scalar type.

GraphQL Schema Conventions

Rescile automatically generates a GraphQL schema based on the resources present in your graph.

Top-Level Fields

Every resource type (e.g., server, application, firewall_rule) is automatically exposed as a top-level query field.

Arguments

  • filter: Filter resources by exact property match (e.g., server(filter: { environment: "prod" })).

Return Structure

When traversing a relationship (edge), the response structure is split into two objects to capture edge-metadata:

  • node: The properties of the target resource itself.
  • properties: The properties of the edge (relationship), including relation (edge type) and any compliance controls.

Special Fields

  • __typename: Standard GraphQL field returning the resource type label.
  • graphJson: A top-level query that returns the entire underlying graph as a raw JSON string.
  • countNodes: A top-level query returning the total number of nodes in the graph.

The JSON Scalar

If a resource has a complex nested object imported “as is” (via the json! directive), it is exposed as a custom JSON scalar type.

This bypasses standard GraphQL strict object typing, allowing arbitrary nested data without enforcing a fixed schema schema or sanitizing characters.