Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Observe

Observe allows Inigo’s users to perform inspection of queries and annotate certain parts of it depending on the configuration you set. For example, you may use Observe to mark/flag fields used in a query depending on the types of directives are applied to them in your GraphQL schema.


This section defines the format of Inigo’s Observe type configuration files. Fields marked as required must be specified if the parent is defined.

Spec

Field Type Description
field_tags [FieldTag]  
directive_tags [string] List of GraphQL Directives Inigo searches for to flag use of deprecated fields.
profile_default_values ObserveProfileDefaultValues  
profiles [ObserveProfile]  

FieldTag

Field Type Description
type string required The GraphQL Type.
field string required The GraphQL Field.
tag string required A tag value.

ObserveProfileDefaultValues

Field Type Description
deprecated_extension boolean Show selected deprecated fields within the response’s extensions key.

ObserveProfile

Field Type Description
Name string required Name of the profile.
deprecated_extension boolean Show selected deprecated fields within the response’s extensions key.