The updateDescriptionForSearchDomain() GraphQL mutation field is used to update the description for a search domain in LogScale.

For more information on searching repositories and views, see the Searching Data documentation page.

Syntax

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

graphql
updateDescriptionForSearchDomain(
      name: string!
      newDescription: string!
   ): UpdateDescriptionMutation!

Returned Datatypes

The returned datatype UpdateDescriptionMutation has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: UpdateDescriptionMutation

ParameterTypeRequired[a]DefaultDescription
descriptionstring  A description of the mutation.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.