-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathschema.graphql
More file actions
1939 lines (1841 loc) · 60.8 KB
/
Copy pathschema.graphql
File metadata and controls
1939 lines (1841 loc) · 60.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
schema {
query: Query
mutation: Mutation
}
"""This directive allows results to be deferred during execution"""
directive @defer(
"""Deferred behaviour is controlled by this argument"""
if: Boolean! = true
"""A unique label that represents the fragment being deferred"""
label: String
) on FRAGMENT_SPREAD | INLINE_FRAGMENT
"""
This directive disables error propagation when a non nullable field returns null for the given operation.
"""
directive @experimental_disableErrorPropagation on MUTATION | QUERY | SUBSCRIPTION
directive @implement(interfaces: [String!]!) on INTERFACE | OBJECT
directive @orderBy on FIELD_DEFINITION
directive @paginated on FIELD_DEFINITION
directive @predicateType on INPUT_OBJECT
"""
Indicates that a field requires the user executing the request to have certain permissions.
"""
directive @requires(permission: Permission) on FIELD_DEFINITION
"""
Indicates that the element (and its children) is unstable and it may change in the future without notice
"""
directive @unstable on FIELD_DEFINITION | OBJECT
"""
Represents an object that can be annotated - method, field or class definition
"""
interface Annotatable {
"""Returns annotations on this object matching the given predicate"""
annotations(
"""An optional filter to apply to the query"""
where: AnnotationPredicate
): [Annotation!]!
}
"""An annotation instance (the type and its value as a JSON object)"""
type Annotation {
"""The type of the annotation - e.g. `java/lang/Deprecated`"""
type: String!
"""The value of this annotation as a JSON object"""
value: JSON
}
"""Used to filter annotations based on different criteria"""
input AnnotationPredicate {
"""Match if all of the given filters match"""
allOf: [AnnotationPredicate!]
"""Match if any of the given filters matches"""
anyOf: [AnnotationPredicate!]
"""
If `true`, match if the value tested is null. Otherwise, match if non-null.
"""
isNull: Boolean
"""
Match if none of the given filters match.
Prefer using this instead of `not(anyOf(...))` as it is generally faster.
"""
noneOf: [AnnotationPredicate!]
"""Invert the given filter"""
not: AnnotationPredicate
"""Filter based on the annotation type"""
type: StringPredicate
"""Filter based on the annotation value"""
value: JSONPredicate
}
"""
A base interfaces for classes identified by their name (e.g. `java/lang/String`)
"""
interface BaseClass implements Identifiable {
"""Returns all known concrete definitions of the class"""
definitions(
"""Optional ordering to apply to the returned elements"""
order: ClassDefinitionOrdering
"""Optional filter applied to the query"""
where: ClassDefinitionPredicate
): [ClassDefinition!]!
"""
The fields of this class, optionally matching the given predicate.
Note that it is not guaranteed that the fields returned have a concrete implementation.
"""
fields(
"""Limit the amount of fields returned"""
limit: Int
"""Optional filter to apply to the query"""
where: FieldPredicate
): [Field!]!
"""The unique ID of this object"""
id: Int!
"""
The methods of this class, optionally matching the given predicate.
Note that it is not guaranteed that the methods returned have a concrete implementation.
"""
methods(
"""Limit the amount of methods returned"""
limit: Int
"""Optional filter to apply to the query"""
where: MethodPredicate
): [Method!]!
"""The name of this class"""
name: String!
}
"""
A base interface used to describe the simple properties of an indexed Mod
"""
interface BaseMod implements Identifiable {
"""The authors of this mod (derived from mod metadata)"""
authors: String
"""The ID of the CurseForge project associated with this mod"""
curseforgeProjectId: Int
"""The unique ID of this object"""
id: Int!
"""The time this mod was last indexed"""
indexedOn: DateTime
"""The license of this mod (derived from mod metadata)"""
license: String
"""The sections of the manifest of the last jar indexed for this mod"""
manifest: [ManifestEntry!]!
"""
The maven coordinates of this mod (only set if this mod was JiJ'd by another mod).
On Fabric these are not real maven coordinates, rather the ID of the mod if the file is a mod, or if the file is a non-mod library, it will be generated by Loom based on its maven coordinates.
"""
mavenCoordinates: String
"""
The metadata of this mod, in JSON format.
Can be sourced from one of the following files depending on the loader:
- `META-INF/neoforge.mods.toml` for NeoForge
- `META-INF/mods.toml` for Forge
- `fabric.mod.json` for Fabric
"""
metadata(
"""
Optional JSONPath to return the element(s) at a specific path from the metadata
"""
path: String
): JSON
"""
The mod IDs of this mod.
Some loaders only allow a mod to have one ID (Fabric) while others may allow a mod file to have multiple mod IDs.
For non-mod files this will be null.
"""
modIds: [String!]
"""The ID of the Modrinth project associated with this mod"""
modrinthProjectId: String
"""
The name of this mod (derived from mod metadata, jar contents or maven coordinates)
"""
name: String!
"""
The artifacts this mod file nests within itself, using a jar-in-jar system.
Note that this is returned as a tree, rather than a flat array containing sub-nested artifacts.
"""
nestedArtifacts: [NestedArtifactNode!]
"""
The artifacts this mod file nests within itself, using a jar-in-jar system.
Note that unlike `nestedArtifacts`, this is returned as a flat array, rather than a tree.
"""
nestedArtifactsFlat: [NestedArtifact!]
"""The last indexed version of this mod"""
version: String!
}
"""Represents an artifact nested within another one"""
interface BaseNestedArtifact {
"""The ID of this artifact"""
id: String!
"""The version of this artifact"""
version: String!
}
"""
Used to cast objects within predicates to concrete types (useful for JSONPath extract predicates)
"""
input CastingPredicate {
"""Cast the object to int"""
int: IntPredicate
"""Cast the object to string"""
string: StringPredicate
}
"""
A class identified by its name (e.g. `java/lang/String`) from which an inheritor search can be started.
"""
type Class implements BaseClass & Identifiable {
"""Returns all known concrete definitions of the class"""
definitions(
"""Optional ordering to apply to the returned elements"""
order: ClassDefinitionOrdering
"""Optional filter applied to the query"""
where: ClassDefinitionPredicate
): [ClassDefinition!]!
"""
The fields of this class, optionally matching the given predicate.
Note that it is not guaranteed that the fields returned have a concrete implementation.
"""
fields(
"""Limit the amount of fields returned"""
limit: Int
"""Optional filter to apply to the query"""
where: FieldPredicate
): [Field!]!
"""The unique ID of this object"""
id: Int!
"""
Returns all known classes that inherit from this class and which optionally match the given filter.
"""
inheritors(
"""Limit the amount of classes returned"""
limit: Int
"""Optional ordering to apply to the returned elements"""
order: InheritanceTreeClassOrdering
"""
A filter to apply to the returned classes.
Note that this filter applies on each node individually. This means that when a class is removed by the predicate, classes that further inherit from it will still be returned.
"""
where: InheritorPredicate
): [InheritanceTreeClass!]!
"""
The methods of this class, optionally matching the given predicate.
Note that it is not guaranteed that the methods returned have a concrete implementation.
"""
methods(
"""Limit the amount of methods returned"""
limit: Int
"""Optional filter to apply to the query"""
where: MethodPredicate
): [Method!]!
"""The name of this class"""
name: String!
}
"""A connection (list) composed of `Class`."""
type ClassConnection {
"""Identifies the amount of items in the returned edges."""
count: Int!
"""A list of edges."""
edges: [ClassEdge!]!
"""Information to aid in pagination."""
pageInfo: PageInfo!
}
"""A concrete definition of a class"""
type ClassDefinition implements Annotatable & ModOwned {
"""Returns annotations on this object matching the given predicate"""
annotations(
"""An optional filter to apply to the query"""
where: AnnotationPredicate
): [Annotation!]!
"""
The fields this class defines directly.
Note that this list is not complete and only contains fields relevant for API usage. Therefore private fields that have no annotations are not tracked.
"""
fields(
"""Limit the amount of fields returned"""
limit: Int
"""Optional ordering to apply to the returned elements"""
order: FieldDefinitionOrdering
"""Optional filter to apply to the query"""
where: FieldPredicate
): [FieldDefinition!]!
"""
The methods this class defines directly.
Note that this list is not complete and only contains methods relevant for API usage. Therefore private methods that have no annotations are not tracked.
"""
methods(
"""Limit the amount of methods returned"""
limit: Int
"""Optional ordering to apply to the returned elements"""
order: MethodDefinitionOrdering
"""Optional filter to apply to the query"""
where: MethodPredicate
): [MethodDefinition!]!
"""The mod that owns this object"""
mod: LightweightMod!
"""The name of this class"""
name: String!
"""
Classes this class directly inherits from (both super classes and interfaces)
"""
parents: [String!]
"""
The fields this class references.
Note that this list is not complete and only contains references relevant for API usage. Therefore references to private or static fields of classes in the same mod are not tracked.
"""
referencedFields: [ReferencedField!]!
"""
The methods this class references.
Note that this list is not complete and only contains references relevant for API usage. Therefore references to private, static or non-overriding methods of classes in the same mod are not tracked.
"""
referencedMethods: [ReferencedMethod!]!
}
"""A connection (list) composed of `ClassDefinition`."""
type ClassDefinitionConnection {
"""Identifies the amount of items in the returned edges."""
count: Int!
"""A list of edges."""
edges: [ClassDefinitionEdge!]!
"""Information to aid in pagination."""
pageInfo: PageInfo!
}
"""An edge of a `ClassDefinition`."""
type ClassDefinitionEdge {
"""The cursor ID of the element."""
cursor: ID!
"""The item at the end of the edge."""
node: ClassDefinition!
}
"""Type used to order `ClassDefinition`s"""
input ClassDefinitionOrdering {
"""Order by name"""
name: OrderMethod
}
"""Used to filter class definitions based on different criteria"""
input ClassDefinitionPredicate {
"""Match if all of the given filters match"""
allOf: [ClassDefinitionPredicate!]
"""
A class definition will match if any of its annotations match the given predicate
"""
anyAnnotation: AnnotationPredicate
"""
A class definition will match if any of the fields it defines matches the given predicate
"""
anyField: FieldDefinitionPredicate
"""
A class definition will match if any of the methods it defines matches the given predicate
"""
anyMethod: MethodDefinitionPredicate
"""Match if any of the given filters matches"""
anyOf: [ClassDefinitionPredicate!]
"""
A class definition will match if any of its <b>direct</b> parents match the given predicate
"""
anyParent: StringPredicate
"""
If `true`, match if the value tested is null. Otherwise, match if non-null.
"""
isNull: Boolean
"""
A class definition will match if the mod that defines it matches the given predicate
"""
mod: ModPredicate
"""Filter based on the class' JVM name"""
name: StringPredicate
"""
Match if none of the given filters match.
Prefer using this instead of `not(anyOf(...))` as it is generally faster.
"""
noneOf: [ClassDefinitionPredicate!]
"""Invert the given filter"""
not: ClassDefinitionPredicate
}
"""An edge of a `Class`."""
type ClassEdge {
"""The cursor ID of the element."""
cursor: ID!
"""The item at the end of the edge."""
node: Class!
}
"""Used to filter classes based on different criteria"""
input ClassPredicate {
"""Match if all of the given filters match"""
allOf: [ClassPredicate!]
"""A class will match if any of its fields match the given predicate"""
anyField: FieldPredicate
"""A class will match if any of its methods match the given predicate"""
anyMethod: MethodPredicate
"""Match if any of the given filters matches"""
anyOf: [ClassPredicate!]
"""
If `true`, match if the value tested is null. Otherwise, match if non-null.
"""
isNull: Boolean
"""Filter based on the class' JVM name"""
name: StringPredicate
"""
Match if none of the given filters match.
Prefer using this instead of `not(anyOf(...))` as it is generally faster.
"""
noneOf: [ClassPredicate!]
"""Invert the given filter"""
not: ClassPredicate
}
"""An arbitrary JSON data file"""
type DataFile implements ModOwned {
"""The mod that owns this object"""
mod: LightweightMod!
"""
The name of this file (e.g. `mymod:my/file` for a file at `data/mymod/somepath/my/file.json`, with the base path of the query being `somepath`)
"""
name: String!
"""The contents of the data file."""
value: JSON!
}
"""A connection (list) composed of `DataFile`."""
type DataFileConnection {
"""Identifies the amount of items in the returned edges."""
count: Int!
"""A list of edges."""
edges: [DataFileEdge!]!
"""Information to aid in pagination."""
pageInfo: PageInfo!
}
"""An edge of a `DataFile`."""
type DataFileEdge {
"""The cursor ID of the element."""
cursor: ID!
"""The item at the end of the edge."""
node: DataFile!
}
"""Used to filter data files based on different criteria"""
input DataFilePredicate {
"""Match if all of the given filters match"""
allOf: [DataFilePredicate!]
"""Match if any of the given filters matches"""
anyOf: [DataFilePredicate!]
"""
If `true`, match if the value tested is null. Otherwise, match if non-null.
"""
isNull: Boolean
"""Filter based on the data file name"""
name: StringPredicate
"""
Match if none of the given filters match.
Prefer using this instead of `not(anyOf(...))` as it is generally faster.
"""
noneOf: [DataFilePredicate!]
"""Invert the given filter"""
not: DataFilePredicate
"""Filter based on the data file JSON contents"""
recipe: JSONPredicate
}
"""A NeoForge data map"""
type DataMap {
"""The entries in this file"""
entries: [DataMapEntry!]!
"""The name of this data map (e.g. `neoforge:compostables`)"""
name: String!
}
"""A connection (list) composed of `DataMap`."""
type DataMapConnection {
"""Identifies the amount of items in the returned edges."""
count: Int!
"""A list of edges."""
edges: [DataMapEdge!]!
"""Information to aid in pagination."""
pageInfo: PageInfo!
}
"""An edge of a `DataMap`."""
type DataMapEdge {
"""The cursor ID of the element."""
cursor: ID!
"""The item at the end of the edge."""
node: DataMap!
}
"""An entry in a NeoForge data map"""
type DataMapEntry {
"""
The key of this entry. Can either be the location of a registry object (e.g. `minecraft:coal_block`) or a tag, denoted by a # at the start (e.g. `#minecraft:logs`)
"""
key: String!
"""The values assigned to this entry by different mods."""
values: [DataMapValue!]!
}
"""A NeoForge data map file"""
type DataMapFile {
"""The entries in this file"""
entries: [DataMapFileEntry!]!
"""The name of this data map (e.g. `neoforge:compostables`)"""
name: String!
}
"""An entry in a NeoForge data map file"""
type DataMapFileEntry {
"""
The key of this entry. Can either be the location of a registry object (e.g. `minecraft:coal_block`) or a tag, denoted by a # at the start (e.g. `#minecraft:logs`)
"""
key: String!
"""
Whether this entry replaces previously added entries for objects within the key without invoking mergers.
Corresponds to the "replace" field at either the top of the data map file or within individual entries.
"""
replace: Boolean!
"""
The value of this entry - i.e. the object attached to the entry with the `key` ID or to entries within the tag, if the `key` is a tag
"""
value: JSON!
}
"""Used to filter data map files based on different criteria"""
input DataMapFilePredicate {
"""Match if all of the given filters match"""
allOf: [DataMapFilePredicate!]
"""Match if any of the given filters matches"""
anyOf: [DataMapFilePredicate!]
"""
If `true`, match if the value tested is null. Otherwise, match if non-null.
"""
isNull: Boolean
"""Filter based on the data map name"""
name: StringPredicate
"""
Match if none of the given filters match.
Prefer using this instead of `not(anyOf(...))` as it is generally faster.
"""
noneOf: [DataMapFilePredicate!]
"""Invert the given filter"""
not: DataMapFilePredicate
}
"""Used to filter data maps based on different criteria"""
input DataMapPredicate {
"""Match if all of the given filters match"""
allOf: [DataMapPredicate!]
"""Match if any of the given filters matches"""
anyOf: [DataMapPredicate!]
"""
If `true`, match if the value tested is null. Otherwise, match if non-null.
"""
isNull: Boolean
"""Filter based on the data map name"""
name: StringPredicate
"""
Match if none of the given filters match.
Prefer using this instead of `not(anyOf(...))` as it is generally faster.
"""
noneOf: [DataMapPredicate!]
"""Invert the given filter"""
not: DataMapPredicate
}
"""A value within a NeoForge data map, associated with an entry"""
type DataMapValue implements ModOwned {
"""The mod that owns this object"""
mod: LightweightMod!
"""
The value of this entry - i.e. the object attached to the entry with the `key` ID or to entries within the tag, if the `key` is a tag
"""
value: JSON!
}
"""A predicate applied to date types"""
input DatePredicate {
"""Matches if the date is after (greater than) the given date"""
after: DateTime
"""Match if all of the given filters match"""
allOf: [DatePredicate!]
"""Match if any of the given filters matches"""
anyOf: [DatePredicate!]
"""Matches if the date is before (smaller than) the given date"""
before: DateTime
"""
If `true`, match if the value tested is null. Otherwise, match if non-null.
"""
isNull: Boolean
"""
Match if none of the given filters match.
Prefer using this instead of `not(anyOf(...))` as it is generally faster.
"""
noneOf: [DatePredicate!]
"""Invert the given filter"""
not: DatePredicate
}
"""A slightly refined version of RFC-3339 compliant DateTime Scalar"""
scalar DateTime
"""A NeoForge enum extension entry"""
type EnumExtension implements ModOwned {
"""The descriptor of the constructor this extension uses"""
constructor: String!
"""The internal name of the enum this extension targets"""
enum: String!
"""The mod that owns this object"""
mod: LightweightMod!
"""The name of the enum field this extension adds"""
name: String!
"""The source of the parameters"""
parameters: JSON!
}
"""A connection (list) composed of `EnumExtension`."""
type EnumExtensionConnection {
"""Identifies the amount of items in the returned edges."""
count: Int!
"""A list of edges."""
edges: [EnumExtensionEdge!]!
"""Information to aid in pagination."""
pageInfo: PageInfo!
}
"""An edge of a `EnumExtension`."""
type EnumExtensionEdge {
"""The cursor ID of the element."""
cursor: ID!
"""The item at the end of the edge."""
node: EnumExtension!
}
"""Used to filter enum extension entries based on different criteria"""
input EnumExtensionPredicate {
"""Match if all of the given filters match"""
allOf: [EnumExtensionPredicate!]
"""Match if any of the given filters matches"""
anyOf: [EnumExtensionPredicate!]
"""Filter based on the enum constructor the extension uses"""
constructor: String
"""Filter based on the internal name of the enum the extension is for"""
enum: StringPredicate
"""
If `true`, match if the value tested is null. Otherwise, match if non-null.
"""
isNull: Boolean
"""Filter based on the name of the enum value the extension adds"""
name: String
"""
Match if none of the given filters match.
Prefer using this instead of `not(anyOf(...))` as it is generally faster.
"""
noneOf: [EnumExtensionPredicate!]
"""Invert the given filter"""
not: EnumExtensionPredicate
}
"""Represents a method as returned by `Class.fields`"""
type Field implements Identifiable & Referenceable {
"""The unique ID of this object"""
id: Int!
"""The name of this field"""
name: String!
"""Returns the references to this element"""
references(
"""Limit the amount of references returned"""
limit: Int
"""Optional ordering to apply to the returned elements"""
order: ReferenceOrdering
"""Optional filter to apply to the query"""
where: ReferencePredicate
): [Reference!]!
"""
The type of this field
Can be a JVM internal class like like `java/lang/Object` or a type descriptor like `I`, `Z` or `[Ljava/lang/Object;`.
"""
type: String!
}
"""A concrete definition of a field"""
type FieldDefinition implements Annotatable {
"""Returns annotations on this object matching the given predicate"""
annotations(
"""An optional filter to apply to the query"""
where: AnnotationPredicate
): [Annotation!]!
"""The name of this method"""
name: String!
"""
The type of this field. This is not a descriptor so classes are in internal JVM format (e.g. `java/lang/String` instead of `Ljava/lang/String;`)
"""
type: String!
}
"""Type used to order `FieldDefinition`s"""
input FieldDefinitionOrdering {
"""Order by name"""
name: OrderMethod
"""Order by type"""
type: OrderMethod
}
"""Used to filter field definitions based on different criteria"""
input FieldDefinitionPredicate {
"""Match if all of the given filters match"""
allOf: [FieldDefinitionPredicate!]
"""Match if any of the given filters matches"""
anyOf: [FieldDefinitionPredicate!]
"""
If `true`, match if the value tested is null. Otherwise, match if non-null.
"""
isNull: Boolean
"""Filter based on the field's name"""
name: StringPredicate
"""
Match if none of the given filters match.
Prefer using this instead of `not(anyOf(...))` as it is generally faster.
"""
noneOf: [FieldDefinitionPredicate!]
"""Invert the given filter"""
not: FieldDefinitionPredicate
"""Filter based on the field's type"""
type: StringPredicate
}
"""Used to filter fields based on different criteria"""
input FieldPredicate {
"""Match if all of the given filters match"""
allOf: [FieldPredicate!]
"""Match if any of the given filters matches"""
anyOf: [FieldPredicate!]
"""
A field will match if any of the (direct) references to it match the given predicate
"""
anyReference: ReferencePredicate
"""
If `true`, match if the value tested is null. Otherwise, match if non-null.
"""
isNull: Boolean
"""Filter based on the field's name"""
name: StringPredicate
"""
Match if none of the given filters match.
Prefer using this instead of `not(anyOf(...))` as it is generally faster.
"""
noneOf: [FieldPredicate!]
"""Invert the given filter"""
not: FieldPredicate
"""Filter based on the field's type"""
type: StringPredicate
}
"""Represents a version of the game on a loader, which WAIFU is indexing"""
type GameVersion {
"""Internal endpoint. It might be removed at any point"""
_modInformation(id: Int!): IntModInformation! @deprecated(reason: "No longer supported")
"""
Get the class with the given `name`. If no such class exists in this game version, this will return `null`.
In contrast to `GameVersion.classes`, this can only query one class by an exact name match, being easier to use and slightly more efficient.
"""
class(
"""The name of the class to query"""
name: String
): Class
"""
Get the class definitions known by this game version that optionally match the given predicate
"""
classDefinitions(
"""Returns the elements in the list that come after the specified cursor."""
after: ID
"""
Returns the elements in the list that come before the specified cursor.
"""
before: ID
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
"""Optional filter applied to the query"""
where: ClassDefinitionPredicate
): ClassDefinitionConnection!
"""
Get the classes known by this game version that optionally match the given predicate
"""
classes(
"""Returns the elements in the list that come after the specified cursor."""
after: ID
"""
Returns the elements in the list that come before the specified cursor.
"""
before: ID
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
"""Optional filter applied to the query"""
where: ClassPredicate
): ClassConnection!
"""
Get the data files known by this game version for the given `location` that optionally match the given predicate.
Note that this will not return files already indexed through other means (i.e. tags, data maps and recipes). Use the dedicated fields to query those.
"""
dataFiles(
"""Returns the elements in the list that come after the specified cursor."""
after: ID
"""
Returns the elements in the list that come before the specified cursor.
"""
before: ID
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
"""
The base path of the data files to return.
For instance, with a base path of `a/b`, data files with a path of `<namespace>/a/b/<path>.json` will be returned.
"""
location: String
"""An optional filter applied to the returned data files"""
where: DataFilePredicate
): DataFileConnection!
"""
Get the data maps known by this game version that optionally match the given predicate.
This returns a different data structure compared to `Mod.dataMaps`, allowing you to query each value assigned to each object
and the mod that does so.
"""
dataMaps(
"""Returns the elements in the list that come after the specified cursor."""
after: ID
"""
Returns the elements in the list that come before the specified cursor.
"""
before: ID
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
"""
The registry to get data maps for.
The format is namespace:registry (e.g. `minecraft:item` or `minecraft:worldgen/biome`)
"""
registry: String!
"""Optional filter applied to the query"""
where: DataMapPredicate
): DataMapConnection!
"""
Get the enum extensions known by this game version that optionally match the given predicate
"""
enumExtensions(
"""Returns the elements in the list that come after the specified cursor."""
after: ID
"""
Returns the elements in the list that come before the specified cursor.
"""
before: ID
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
"""Optional filter applied to the query"""
where: EnumExtensionPredicate
): EnumExtensionConnection!
"""The loader this game version indexes"""
loader: Loader!
"""Query mods from the database"""
mods(
"""Returns the elements in the list that come after the specified cursor."""
after: ID
"""
Returns the elements in the list that come before the specified cursor.
"""
before: ID
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
"""Optional filter applied to the query"""
where: ModPredicate
): ModConnection!
"""
Get the mods from the database that have the given IDs.
Note that the mods are not returned in a specific order relative to the input IDs.
"""
modsById(
"""Returns the elements in the list that come after the specified cursor."""
after: ID
"""
Returns the elements in the list that come before the specified cursor.
"""
before: ID
"""Returns the first _n_ elements from the list."""
first: Int
"""
The mod IDs to query.
If it exceeds the maximum amount of elements that a single query can return you can paginate it further.
"""
ids: [Int!]!
"""Returns the last _n_ elements from the list."""
last: Int
): ModConnection!
"""
Get the recipe files known by this game version that optionally match the given predicate
"""
recipes(
"""Returns the elements in the list that come after the specified cursor."""
after: ID
"""
Returns the elements in the list that come before the specified cursor.
"""
before: ID
"""Returns the first _n_ elements from the list."""
first: Int
"""Returns the last _n_ elements from the list."""
last: Int
"""Optional filter applied to the query"""
where: RecipeFilePredicate
): RecipeFileConnection!
"""The Minecraft version this game version indexes"""
version: String!
}
"""
Represents an object that is identifiable by an unique ID (within its category)
"""
interface Identifiable {
"""The unique ID of this object"""
id: Int!
}
"""
A class identified by its name (e.g. `java/lang/String`) as returned by `Class.inheritors` which has a certain depth from the root of the inheritance tree.
"""
type InheritanceTreeClass implements BaseClass & Identifiable {
"""Returns all known concrete definitions of the class"""
definitions(
"""Optional ordering to apply to the returned elements"""
order: ClassDefinitionOrdering
"""Optional filter applied to the query"""
where: ClassDefinitionPredicate
): [ClassDefinition!]!
"""
The depth of this class in the inheritance tree.
Classes with a depth of 1 are direct children of the class from which the search was started, classes with a depth of 2 are their children and so on.
"""
depth: Int!
"""
The fields of this class, optionally matching the given predicate.
Note that it is not guaranteed that the fields returned have a concrete implementation.
"""
fields(
"""Limit the amount of fields returned"""
limit: Int
"""Optional filter to apply to the query"""
where: FieldPredicate
): [Field!]!
"""The unique ID of this object"""
id: Int!
"""
The methods of this class, optionally matching the given predicate.
Note that it is not guaranteed that the methods returned have a concrete implementation.
"""
methods(
"""Limit the amount of methods returned"""
limit: Int
"""Optional filter to apply to the query"""
where: MethodPredicate
): [Method!]!
"""The name of this class"""
name: String!
}
"""Type used to order `InheritanceTreeClass`s"""
input InheritanceTreeClassOrdering {
"""Order by depth"""
depth: OrderMethod
}
"""Used to filter inheriting classes based on different criteria"""
input InheritorPredicate {
"""Match if all of the given filters match"""
allOf: [InheritorPredicate!]
"""Match if any of the given filters matches"""
anyOf: [InheritorPredicate!]
"""Filter based on the class' depth in the inheritance tree"""
depth: IntPredicate
"""
If `true`, match if the value tested is null. Otherwise, match if non-null.
"""
isNull: Boolean
"""Filter based on the class' JVM name"""
name: StringPredicate
"""
Match if none of the given filters match.
Prefer using this instead of `not(anyOf(...))` as it is generally faster.
"""
noneOf: [InheritorPredicate!]
"""Invert the given filter"""
not: InheritorPredicate
}
type IntModInformation implements BaseMod & Identifiable {
"""The authors of this mod (derived from mod metadata)"""
authors: String
curseforge: IntPlatformInformation
"""The ID of the CurseForge project associated with this mod"""