entgql: added Description() for adding meta data to a field

[Albert-Gao]

No description provided.

[a8m]

Thanks for the contribution @Albert-Gao.

The next thing is to add it to the gqlparser/ast.Definition.

[Albert-Gao]

@a8m thanks for the comments, how to do this please? I checked the file, but do not know how to link the added the field to this FieldConfig.Descrption. What I am missing here please? Thanks :)

[giautm]

Hello @Albert-Gao, you need to add def.Description to this block of code. It's our query field on the Query Object.

contrib/entgql/schema.go

Lines 208 to 231 in a1f3cb4

	if ant.RelayConnection {
	if !e.relaySpec {
	return ErrRelaySpecDisabled
	}
	s.AddTypes(names.TypeDefs()...)
	if ant.QueryField != nil {
	name := ant.QueryField.fieldName(gqlType)
	_, hasOrderBy := s.Types[names.Order]
	hasWhereInput := e.genWhereInput && !ant.Skip.Is(SkipWhereInput)
	def := names.ConnectionField(name, hasOrderBy, hasWhereInput)
	def.Directives = e.buildDirectives(ant.QueryField.Directives)
	queryFields = append(queryFields, def)
	}
	} else if ant.QueryField != nil {
	name := ant.QueryField.fieldName(gqlType)
	def := &ast.FieldDefinition{
	Name: name,
	Type: listNamedType(gqlType, false),
	}
	def.Directives = e.buildDirectives(ant.QueryField.Directives)
	queryFields = append(queryFields, def)
	}

The latest thing, don't forget to merge annotation if we have more than one on the entity:

contrib/entgql/annotation.go

Lines 463 to 471 in a1f3cb4

	func (c *FieldConfig) merge(ant *FieldConfig) {
	if ant == nil {
	return
	}
	if ant.Name != "" {
	c.Name = ant.Name
	}
	c.Directives = append(c.Directives, ant.Directives...)
	}

[Albert-Gao]

Thanks, @giautm added, please check.

[Albert-Gao]

I am not quite sure how to test the outcome of this, when running the tests locally, I have an error and do not know how to solve it.

[Albert-Gao]

Why this test is failing locally? 🤣
anyway, fixed the test of the updated schema