API Stability Long-Term

The enableFieldAliasSchemaOnViews() GraphQL mutation field is used to enable the schema on the given list of views or repositories. Field alias mappings in this schema will be active during search within this view or repository. If at least one view fails to be enabled on the given view, no changes are performed on any of the views.

Syntax

Below is the syntax for the enableFieldAliasSchemaOnViews() mutation field:

graphql
enableFieldAliasSchemaOnViews(
      input: EnableFieldAliasSchemaOnViewsInput!
   ): boolean!

Given Datatypes

For the given datatype, EnableFieldAliasSchemaOnViewsInput(), there are a couple of parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: EnableFieldAliasSchemaOnViewsInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 18, 2024
schemaIdstringyes Long-TermThe unique identifier of the schema related to the field aliases to enable.
viewNames[string]yes Long-TermThe names of the views related to the field aliases to enable.