The updateFieldAliasSchema() GraphQL mutation may be used to update an existing schema.

Syntax

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

graphql
updateFieldAliasSchema(
      input: UpdateFieldAliasSchemaInput!
   ): FieldAliasSchema

Given Datatypes

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

Table: UpdateFieldAliasSchemaInput

ParameterTypeRequiredDefaultDescription
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 23, 2024
aliasMappings[AliasMappingInput]yes The alias mappings on the schema. This overrides the existing alias mappings. If not supplied, the alias mapping will be unchanged. See AliasMappingInput.
fields[SchemaFieldInput]yes The fields of the schema. This overrides the existing fields. If not supplied, the fields will be unchanged. See SchemaFieldInput.
idstringyes The unique identifier of the schema.
namestring  The name of the schema. This will override the existing name. If not supplied, the name will be unchanged.