API Stability Long-Term

The updateFieldAliasMapping() GraphQL mutation may be used to update an alias mapping on a schema.

Syntax

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

graphql
updateFieldAliasMapping(
      input: UpdateFieldAliasMappingInput!
   ): string

Below is an example of how this mutation field might be used:

Show:
graphql
mutation {
  updateFieldAliasMapping( input:
     { schemaId: "abc123",
       aliasMappingId: "def456",
       aliases: [ { source: "some", alias: "thing" } ]
     } 
  )
}

Given Datatypes

For UpdateFieldAliasMappingInput, there are a few parameters. Below is a list of them along with a description of each:

Table: UpdateFieldAliasMappingInput

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 23, 2024
aliases[AliasInfoInput]yes Long-TermA list of aliases. See AliasInfoInput.
aliasMappingIdstringyes Long-TermThe alias mapping identifier.
namestring  Long-TermThe name of the Alias mapping. This overrides the existing name. If not given, it's unchanged.
originalFieldsToKeep[string]yes Long-TermSource fields that are aliased, but should still be available in the query. This overrides the existing values. If not given, it's unchanged.
schemaIdstringyes Long-TermThe unique identifier of the schema on which the alias mapping exists.
tags[TagsInput]yes Long-TermThe tags of the alias mapping. This overrides the existing tags. If not given, they're unchanged. See TagsInput.