Skip to content

Commit dd31ab2

Browse files
author
jane-olszewska
committed
Added a description field to schema type definition classes
1 parent bbb5cf1 commit dd31ab2

10 files changed

+83
-19
lines changed

src/Language/AST/EnumTypeDefinitionNode.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,9 @@ class EnumTypeDefinitionNode extends Node implements TypeDefinitionNode
2222
* @var EnumValueDefinitionNode[]
2323
*/
2424
public $values;
25+
26+
/**
27+
* @var string
28+
*/
29+
public $description;
2530
}

src/Language/AST/EnumValueDefinitionNode.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,9 @@ class EnumValueDefinitionNode extends Node
1717
* @var DirectiveNode[]
1818
*/
1919
public $directives;
20+
21+
/**
22+
* @var string
23+
*/
24+
public $description;
2025
}

src/Language/AST/FieldDefinitionNode.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,9 @@ class FieldDefinitionNode extends Node
2727
* @var DirectiveNode[]
2828
*/
2929
public $directives;
30+
31+
/**
32+
* @var string
33+
*/
34+
public $description;
3035
}

src/Language/AST/InputObjectTypeDefinitionNode.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,9 @@ class InputObjectTypeDefinitionNode extends Node implements TypeDefinitionNode
2222
* @var InputValueDefinitionNode[]
2323
*/
2424
public $fields;
25+
26+
/**
27+
* @var string
28+
*/
29+
public $description;
2530
}

src/Language/AST/InputValueDefinitionNode.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,9 @@ class InputValueDefinitionNode extends Node
2727
* @var DirectiveNode[]
2828
*/
2929
public $directives;
30+
31+
/**
32+
* @var string
33+
*/
34+
public $description;
3035
}

src/Language/AST/InterfaceTypeDefinitionNode.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,9 @@ class InterfaceTypeDefinitionNode extends Node implements TypeDefinitionNode
2222
* @var FieldDefinitionNode[]
2323
*/
2424
public $fields = [];
25+
26+
/**
27+
* @var string
28+
*/
29+
public $description;
2530
}

src/Language/AST/ObjectTypeDefinitionNode.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,9 @@ class ObjectTypeDefinitionNode extends Node implements TypeDefinitionNode
2727
* @var FieldDefinitionNode[]
2828
*/
2929
public $fields;
30+
31+
/**
32+
* @var string
33+
*/
34+
public $description;
3035
}

src/Language/AST/ScalarTypeDefinitionNode.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,9 @@ class ScalarTypeDefinitionNode extends Node implements TypeDefinitionNode
1717
* @var DirectiveNode[]
1818
*/
1919
public $directives;
20+
21+
/**
22+
* @var string
23+
*/
24+
public $description;
2025
}

src/Language/AST/UnionTypeDefinitionNode.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,9 @@ class UnionTypeDefinitionNode extends Node implements TypeDefinitionNode
2222
* @var NamedTypeNode[]
2323
*/
2424
public $types = [];
25+
26+
/**
27+
* @var string
28+
*/
29+
public $description;
2530
}

tests/Language/SchemaParserTest.php

Lines changed: 38 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ public function testSimpleType()
5454
$loc(16, 29)
5555
)
5656
],
57-
'loc' => $loc(1, 31)
57+
'loc' => $loc(1, 31),
58+
'description' => null
5859
]
5960
],
6061
'loc' => $loc(0, 31)
@@ -93,7 +94,8 @@ public function testSimpleExtension()
9394
$loc(23, 36)
9495
)
9596
],
96-
'loc' => $loc(8, 38)
97+
'loc' => $loc(8, 38),
98+
'description' => null
9799
],
98100
'loc' => $loc(1, 38)
99101
]
@@ -136,7 +138,8 @@ public function testSimpleNonNullType()
136138
$loc(16,30)
137139
)
138140
],
139-
'loc' => $loc(1,32)
141+
'loc' => $loc(1,32),
142+
'description' => null
140143
]
141144
],
142145
'loc' => $loc(0,32)
@@ -165,7 +168,8 @@ public function testSimpleTypeInheritingInterface()
165168
],
166169
'directives' => [],
167170
'fields' => [],
168-
'loc' => $loc(0,31)
171+
'loc' => $loc(0,31),
172+
'description' => null
169173
]
170174
],
171175
'loc' => $loc(0,31)
@@ -195,7 +199,8 @@ public function testSimpleTypeInheritingMultipleInterfaces()
195199
],
196200
'directives' => [],
197201
'fields' => [],
198-
'loc' => $loc(0, 33)
202+
'loc' => $loc(0, 33),
203+
'description' => null
199204
]
200205
],
201206
'loc' => $loc(0, 33)
@@ -221,7 +226,8 @@ public function testSingleValueEnum()
221226
'name' => $this->nameNode('Hello', $loc(5, 10)),
222227
'directives' => [],
223228
'values' => [$this->enumValueNode('WORLD', $loc(13, 18))],
224-
'loc' => $loc(0, 20)
229+
'loc' => $loc(0, 20),
230+
'description' => null
225231
]
226232
],
227233
'loc' => $loc(0, 20)
@@ -250,7 +256,8 @@ public function testDoubleValueEnum()
250256
$this->enumValueNode('WO', $loc(13, 15)),
251257
$this->enumValueNode('RLD', $loc(17, 20))
252258
],
253-
'loc' => $loc(0, 22)
259+
'loc' => $loc(0, 22),
260+
'description' => null
254261
]
255262
],
256263
'loc' => $loc(0, 22)
@@ -285,7 +292,8 @@ interface Hello {
285292
$loc(21, 34)
286293
)
287294
],
288-
'loc' => $loc(1, 36)
295+
'loc' => $loc(1, 36),
296+
'description' => null
289297
]
290298
],
291299
'loc' => $loc(0,36)
@@ -328,7 +336,8 @@ public function testSimpleFieldWithArg()
328336
$loc(16, 44)
329337
)
330338
],
331-
'loc' => $loc(1, 46)
339+
'loc' => $loc(1, 46),
340+
'description' => null
332341
]
333342
],
334343
'loc' => $loc(0, 46)
@@ -372,7 +381,8 @@ public function testSimpleFieldWithArgWithDefaultValue()
372381
$loc(16, 51)
373382
)
374383
],
375-
'loc' => $loc(1, 53)
384+
'loc' => $loc(1, 53),
385+
'description' => null
376386
]
377387
],
378388
'loc' => $loc(0, 53)
@@ -415,7 +425,8 @@ public function testSimpleFieldWithListArg()
415425
$loc(16, 47)
416426
)
417427
],
418-
'loc' => $loc(1, 49)
428+
'loc' => $loc(1, 49),
429+
'description' => null
419430
]
420431
],
421432
'loc' => $loc(0, 49)
@@ -465,7 +476,8 @@ public function testSimpleFieldWithTwoArgs()
465476
$loc(16, 59)
466477
)
467478
],
468-
'loc' => $loc(1, 61)
479+
'loc' => $loc(1, 61),
480+
'description' => null
469481
]
470482
],
471483
'loc' => $loc(0, 61)
@@ -490,7 +502,8 @@ public function testSimpleUnion()
490502
'name' => $this->nameNode('Hello', $loc(6, 11)),
491503
'directives' => [],
492504
'types' => [$this->typeNode('World', $loc(14, 19))],
493-
'loc' => $loc(0, 19)
505+
'loc' => $loc(0, 19),
506+
'description' => null
494507
]
495508
],
496509
'loc' => $loc(0, 19)
@@ -519,7 +532,8 @@ public function testUnionWithTwoTypes()
519532
$this->typeNode('Wo', $loc(14, 16)),
520533
$this->typeNode('Rld', $loc(19, 22))
521534
],
522-
'loc' => $loc(0, 22)
535+
'loc' => $loc(0, 22),
536+
'description' => null
523537
]
524538
],
525539
'loc' => $loc(0, 22)
@@ -542,7 +556,8 @@ public function testScalar()
542556
'kind' => NodeKind::SCALAR_TYPE_DEFINITION,
543557
'name' => $this->nameNode('Hello', $loc(7, 12)),
544558
'directives' => [],
545-
'loc' => $loc(0, 12)
559+
'loc' => $loc(0, 12),
560+
'description' => null
546561
]
547562
],
548563
'loc' => $loc(0, 12)
@@ -577,7 +592,8 @@ public function testSimpleInputObject()
577592
$loc(17, 30)
578593
)
579594
],
580-
'loc' => $loc(1, 32)
595+
'loc' => $loc(1, 32),
596+
'description' => null
581597
]
582598
],
583599
'loc' => $loc(0, 32)
@@ -629,7 +645,8 @@ private function fieldNodeWithArgs($name, $type, $args, $loc)
629645
'arguments' => $args,
630646
'type' => $type,
631647
'directives' => [],
632-
'loc' => $loc
648+
'loc' => $loc,
649+
'description' => null
633650
];
634651
}
635652

@@ -639,7 +656,8 @@ private function enumValueNode($name, $loc)
639656
'kind' => NodeKind::ENUM_VALUE_DEFINITION,
640657
'name' => $this->nameNode($name, $loc),
641658
'directives' => [],
642-
'loc' => $loc
659+
'loc' => $loc,
660+
'description' => null
643661
];
644662
}
645663

@@ -651,7 +669,8 @@ private function inputValueNode($name, $type, $defaultValue, $loc)
651669
'type' => $type,
652670
'defaultValue' => $defaultValue,
653671
'directives' => [],
654-
'loc' => $loc
672+
'loc' => $loc,
673+
'description' => null
655674
];
656675
}
657676
}

0 commit comments

Comments
 (0)