feat: add comments to relay connection edges and query fields

Author: tobikris

entgql/internal/todoglobalid/ent.graphql

@@ -1255,6 +1255,9 @@ type User implements Node {
   username: UUID!
   requiredMetadata: Map!
   metadata: Map
+  """
+  The groups of the user
+  """
   groups(
     """
     Returns the elements in the list that come after the specified cursor.

entgql/internal/todoglobalid/schema/group.go

@@ -49,7 +49,8 @@ func (Group) Edges() []ent.Edge {
 func (Group) Annotations() []schema.Annotation {
 	return []schema.Annotation{
 		entgql.RelayConnection(),
-		entgql.QueryField(),
+		entgql.QueryField().
+			Description("The groups of the user"),
 		entgql.Directives(
 			annotation.HasPermissions([]string{"ADMIN", "MODERATOR"}),
 		),

entgql/schema.go

@@ -219,7 +219,7 @@ func (e *schemaGenerator) buildTypes(g *gen.Graph, s *ast.Schema) error {
 					_, hasOrderBy := s.Types[names.Order]
 					hasWhereInput := e.genWhereInput && !ant.Skip.Is(SkipWhereInput)
 
-					def := names.ConnectionField(name, hasOrderBy, ant.MultiOrder, hasWhereInput)
+					def := names.ConnectionField(name, ant.Description, hasOrderBy, ant.MultiOrder, hasWhereInput)
 					def.Description = ant.QueryField.Description
 					def.Directives = e.buildDirectives(ant.QueryField.Directives)
 					queryFields = append(queryFields, def)
@@ -456,7 +456,7 @@ func (e *schemaGenerator) buildEdge(node *gen.Type, edge *gen.Edge, edgeAnt *Ann
 			}
 
 			fieldDef = paginationNames(gqlType).
-				ConnectionField(name, len(orderFields) > 0, ant.MultiOrder,
+				ConnectionField(name, edge.Comment(), len(orderFields) > 0, ant.MultiOrder,
 					e.genWhereInput && !edgeAnt.Skip.Is(SkipWhereInput) && !ant.Skip.Is(SkipWhereInput),
 				)
 		default:

entgql/template.go

@@ -632,10 +632,11 @@ func (p *PaginationNames) OrderInputDef() *ast.Definition {
 	}
 }
 
-func (p *PaginationNames) ConnectionField(name string, hasOrderBy, multiOrder, hasWhereInput bool) *ast.FieldDefinition {
+func (p *PaginationNames) ConnectionField(name, description string, hasOrderBy, multiOrder, hasWhereInput bool) *ast.FieldDefinition {
 	def := &ast.FieldDefinition{
-		Name: name,
-		Type: ast.NonNullNamedType(p.Connection, nil),
+		Name:        name,
+		Description: description,
+		Type:        ast.NonNullNamedType(p.Connection, nil),
 		Arguments: ast.ArgumentDefinitionList{
 			{
 				Name:        "after",

entgql/testdata/schema_relay.graphql

@@ -1209,6 +1209,9 @@ type User implements Node {
   username: UUID!
   requiredMetadata: Map!
   metadata: Map
+  """
+  The groups of the user
+  """
   groups(
     """
     Returns the elements in the list that come after the specified cursor.

entgql/testdata/schema_relay_output.graphql

@@ -1209,6 +1209,9 @@ type User implements Node {
   username: UUID!
   requiredMetadata: Map!
   metadata: Map
+  """
+  The groups of the user
+  """
   groups(
     """
     Returns the elements in the list that come after the specified cursor.