-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathschema.graphql
1864 lines (1371 loc) · 37.3 KB
/
schema.graphql
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
"""Directive for applying default values to nullable fields"""
directive @default(value: String!) on FIELD_DEFINITION
"""Converts MongoDB ObjectId value to the Global Unique ID"""
directive @toGlobalId(type: String!) on FIELD_DEFINITION
"""Extracts value from specified field in parent object"""
directive @fromField(name: String!) on FIELD_DEFINITION
"""
Directive for multilingual fields support
On input field maps provided value to multilingual object (e.g. 'hello' => {en: 'hello'})
On type field maps multilingual object to value ({en: 'hello'} => 'hello')
"""
directive @multilingual on FIELD_DEFINITION | INPUT_FIELD_DEFINITION
"""Load data via specific dataLoader"""
directive @dataLoader(
"""Name of needed DataLoader"""
dataLoaderName: String!
"""Name of field with data for DataLoader"""
fieldName: String
"""Arg name to extract id from"""
argName: String
) on FIELD_DEFINITION
"""Directive for pagination according to the Relay specification"""
directive @pagination(collectionName: String!) on FIELD_DEFINITION
"""Directive for checking user authorization"""
directive @authCheck on FIELD_DEFINITION
"""Directive for checking admin permissions"""
directive @adminCheck on FIELD_DEFINITION
"""Directive for checking editor permissions"""
directive @editorCheck on FIELD_DEFINITION
"""Exposes a URL that specifies the behaviour of this scalar."""
directive @specifiedBy(
"""The URL that specifies the behaviour of this scalar."""
url: String!
) on SCALAR
"""An achievement that a user can get for completing a quest"""
type Achievement implements Node {
"""Achievement identifier"""
id: ID!
"""Achievement name"""
name: String!
"""Unit of measure in which the value is calculated"""
unit: AchievementUnits!
"""Current value reached by the user"""
currentValue: Float!
"""The value you need to get the achievement"""
requiredValue: Float!
}
"""Unit of measure in which the value is calculated"""
enum AchievementUnits {
"""Distance unit, for example, kilometrs"""
DISTANCE
"""Quantity unit, for example, number of passed quests"""
QUANTITY
}
input AddArchitectInput {
"""Location instance id"""
locationInstanceId: GlobalId!
"""Architect for adding"""
architectId: GlobalId!
}
type AddArchitectPayload {
"""New relation id"""
recordId: GlobalId!
"""New relation"""
record: Relation!
}
"""Location address representation"""
type Address {
"""Country data"""
country: Country
"""Country region data"""
region: Region
"""City name, e.g. Saint-Petersburg"""
place: MultilingualString
"""City district e.g. Адмиралтейский округ"""
locality: MultilingualString
"""The first line of an address e.g. Пл. Никольская 1"""
address: MultilingualString
"""An optional second line of an address"""
address2: MultilingualString
"""Address postcode"""
postcode: MultilingualString
}
"""Types of applications where quest will be displayed"""
enum Application {
"""Que.St application"""
MOBILE
"""St.Retrospect application"""
WEB
}
"""Country data in address of location"""
type Country implements Node {
"""Country identifier"""
id: ID!
"""ISO 3166 country code"""
code: String!
"""Country name"""
name: MultilingualString!
}
"""Input type for specifying address in new location"""
input CreateAddressInput {
"""Unique country code from ISO 3166"""
countryCode: String!
"""Unique region code from ISO 3166"""
regionCode: String!
"""City name, e.g. Saint-Petersburg"""
place: MultilingualString
"""City district e.g. Адмиралтейский округ"""
locality: MultilingualString
"""The first line of an address e.g. Пл. Никольская 1"""
address: MultilingualString!
"""An optional second line of an address"""
address2: MultilingualString
"""Address postcode"""
postcode: MultilingualString
}
"""Input for creating new location"""
input CreateLocationInput {
"""Location position latitude"""
latitude: Float!
"""Location position longitude"""
longitude: Float!
"""Possible location representations"""
instances: [LocationInstanceInput!]!
"""Address to bind to new location"""
addresses: [CreateAddressInput!]!
}
input CreateLocationInstanceInput {
"""Location's name"""
name: MultilingualString!
"""Location's description"""
description: MultilingualString!
"""Location style id"""
locationStyleId: GlobalId
"""Link for location info"""
wikiLink: String
"""Contains links with location's photos"""
photoLinks: [String!]
"""Link with main photo"""
mainPhotoLink: String
"""Location's construction date"""
constructionDate: String
"""Location's demolition date"""
demolitionDate: String
"""Start of period"""
startDate: String
"""End of period"""
endDate: String
"""Location id to which this instance below"""
locationId: GlobalId!
"""Source of information about location instance"""
source: MultilingualString!
"""Location instance tags"""
tagIds: [GlobalId!]!
}
type CreateLocationInstancePayload {
"""Created location id"""
recordId: GlobalId!
"""Created location"""
record: LocationInstance!
}
type CreateLocationPayload {
"""Created location id"""
recordId: GlobalId!
"""Created location"""
record: Location!
}
"""Input for create mutation"""
input CreateLocationStyleInput {
name: MultilingualString!
}
"""Payload of create mutation response"""
type CreateLocationStylePayload {
"""New record id"""
recordId: GlobalId!
"""Location style object"""
record: LocationStyle!
}
input CreatePersonInput {
"""Person's last name"""
lastName: MultilingualString
"""Person's first name"""
firstName: MultilingualString
"""Person's patronymic"""
patronymic: MultilingualString
"""Person's pseudonym"""
pseudonym: MultilingualString
"""Link with main photo"""
mainPhotoLink: String
"""Link with photo for card"""
cardPhotoLink: String
"""Person's professions"""
professions: [String!]
"""Person's description"""
description: MultilingualString
"""Person's birth date"""
birthDate: String
"""Person's death date"""
deathDate: String
"""Contains links with person's photos"""
photoLinks: [String!]
"""Person's info link"""
wikiLink: String
"""Person tags"""
tagIds: [GlobalId!]!
}
type CreatePersonPayload {
"""Created person id"""
recordId: GlobalId!
"""Created person"""
record: Person!
}
input CreateQuestInput {
"""Quest name"""
name: String!
"""Quest description"""
description: String
"""Quest content languange"""
language: Languages! = RU
"""What user needs to use for route passing"""
wayToTravel: WayToTravel! = ON_FOOT
"""Where quest will be displayed"""
whereDisplays: [Application!]! = []
"""Quest duration in minutes"""
durationInMinutes: Int!
"""Quest distance in kilometers"""
distanceInKilometers: Float!
"""Quest photo"""
photo: String
"""Quest type (quiz, route, etc.)"""
type: TaskTypes! = ROUTE
"""The minimum level required by the user to complete this quest"""
minLevel: Int!
"""The experience that the user will receive by completing this quest"""
earnedExp: Int!
"""Quest data"""
data: EditorDataInput!
"""Information about quest authors"""
credits: EditorDataInput!
"""Quest tags"""
tagIds: [GlobalId!]!
"""Cards ids that user will get after quest passing"""
personsCardsIds: [GlobalId!]!
"""Achievements that the user can get after completing the quest"""
linkedAchievementsIds: [GlobalId!]!
}
type CreateQuestPayload {
"""Created quest id"""
recordId: GlobalId!
"""Created quest"""
record: Quest!
}
input CreateRelationInput {
"""Person ID in relation"""
personId: GlobalId!
"""Location Instance ID in relation"""
locationInstanceId: GlobalId!
"""Relation type ID"""
relationId: GlobalId!
"""Quote about relation"""
quote: MultilingualString!
"""Link to quote"""
link: MultilingualString!
"""Date of relation start"""
startDate: String!
"""Date of relation end"""
endDate: String!
}
type CreateRelationPayload {
"""Created relation id"""
recordId: GlobalId!
"""Created relation"""
record: Relation!
}
input CreateRelationTypeInput {
"""Relation type name"""
name: MultilingualString!
"""Relation type synonyms"""
synonyms: [String!]
}
type CreateRelationTypePayload {
"""Created relation type id"""
recordId: GlobalId!
"""Created relation type"""
record: RelationType!
}
input CreateTagInput {
"""Value of tag"""
value: MultilingualString!
}
type CreateTagPayload {
"""Created tag id"""
recordId: GlobalId!
"""Created tag object"""
record: Tag!
}
scalar Cursor
type DeleteLocationInstancePayload {
"""Created location id"""
recordId: GlobalId!
}
type DeleteLocationPayload {
"""Deleted location id"""
recordId: GlobalId!
}
"""Payload of delete mutation"""
type DeleteLocationStylePayload {
"""Deleted record id"""
recordId: GlobalId!
}
type DeletePersonPayload {
"""Deleted person id"""
recordId: GlobalId!
}
type DeleteQuestPayload {
"""Deleted quest id"""
recordId: GlobalId!
}
type DeleteRelationPayload {
"""Deleted relation id"""
recordId: GlobalId!
}
type DeleteRelationTypePayload {
"""Deleted relation type id"""
recordId: GlobalId!
}
type DeleteTagPayload {
"""Deleted tag id"""
recordId: GlobalId!
}
"""
Data saved from Editor.js
See https://editorjs.io/saving-data
"""
type EditorData {
"""Saving timestamp"""
time: Timestamp
"""List of Blocks data"""
blocks: [JSON!]!
"""Version of Editor.js"""
version: String
}
"""
Data saved from Editor.js
See https://editorjs.io/saving-data
"""
input EditorDataInput {
"""Saving timestamp"""
time: Timestamp
"""List of Blocks data"""
blocks: [JSON!]!
"""Version of Editor.js"""
version: String
}
scalar GlobalId
"""
The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).
"""
scalar JSON
"""Supported languages for data"""
enum Languages {
EN
RU
}
"""Location for displaying on map and making relations with persons"""
type Location implements Node {
"""Location's ID"""
id: ID!
"""Location position latitude"""
latitude: Float
"""Location position longitude"""
longitude: Float
"""Array of addresses ids"""
addresses: [Address!]
"""Possible location representations"""
instances: [LocationInstance!]!
}
"""Model for representing list of locations"""
type LocationConnection {
"""List of locations edges"""
edges: [LocationEdge!]!
"""Information about this page"""
pageInfo: PageInfo!
"""Number of available edges"""
totalCount: Int!
}
"""Information about specific location in connection"""
type LocationEdge {
"""Cursor of this location"""
cursor: Cursor!
"""Location info"""
node: Location!
"""How much the location matches the search term"""
searchScore: Float
}
"""
Location context. This can be a time period, a special description for a particular route, etc.
"""
type LocationInstance implements Node {
"""Instance's ID"""
id: ID!
"""Location's name"""
name: String
"""Location"""
location: Location!
"""Location's description"""
description: String
"""Link for location info"""
wikiLink: String
"""Array of location's types"""
locationTypes: [LocationType!]
"""Location style"""
locationStyle: LocationStyle
"""Contains links with location's photos"""
photoLinks: [String!]
"""Link with main photo"""
mainPhotoLink: String
"""Location's construction date"""
constructionDate: String
"""Location's demolition date"""
demolitionDate: String
"""Start of period"""
startDate: String
"""End of period"""
endDate: String
"""Location relations"""
relations: [Relation!]!
"""Array of architects"""
architects: [Person!]!
"""Source of information about location instance"""
source: MultilingualString
"""Location instance tags"""
tags: [Tag!]!
}
"""Model for representing list of locations instances"""
type LocationInstanceConnection {
"""List of location instances edges"""
edges: [LocationInstanceEdge!]!
"""Information about this page"""
pageInfo: PageInfo!
"""Number of available edges"""
totalCount: Int!
}
"""Information about specific location instance in connection"""
type LocationInstanceEdge {
"""Cursor of this location"""
cursor: Cursor!
"""Location instance info"""
node: LocationInstance!
}
input LocationInstanceInput {
"""Location's name"""
name: MultilingualString!
"""Location's description"""
description: MultilingualString!
"""Link for location info"""
wikiLink: String
"""Contains links with location's photos"""
photoLinks: [String!]
"""Link with main photo"""
mainPhotoLink: String
"""Location's construction date"""
constructionDate: String
"""Location's demolition date"""
demolitionDate: String
"""Start of period"""
startDate: String
"""End of period"""
endDate: String
"""Location instance tags"""
tagIds: [GlobalId!]
}
type LocationInstanceMutations {
"""Create location instance"""
create(input: CreateLocationInstanceInput!): CreateLocationInstancePayload!
"""Add architect to location instance"""
addArchitect(input: AddArchitectInput!): AddArchitectPayload!
"""Remove architects from location instance"""
removeArchitect(input: RemoveArchitectInput!): RemoveArchitectPayload!
"""Update location instance"""
update(input: UpdateLocationInstanceInput!): UpdateLocationInstancePayload!
"""Delete location instance"""
delete(id: GlobalId!): DeleteLocationInstancePayload!
}
type LocationMutations {
"""Create location"""
create(input: CreateLocationInput!): CreateLocationPayload!
"""Update location"""
update(input: UpdateLocationInput!): UpdateLocationPayload!
"""Delete location"""
delete(id: GlobalId!): DeleteLocationPayload!
}
"""Model for representing result of locations search query"""
type LocationsSearchResult {
"""List of finded locations"""
nodes: [Location!]!
"""Number of available result items"""
totalCount: Int!
"""Proposed query if user made a typo"""
suggest: String
"""Proposed query if user made a typo with indication of the place of it"""
highlightedSuggest: String
}
"""Location style"""
type LocationStyle implements Node {
"""LoactionStyle ID"""
id: ID!
"""LocationStyle name"""
name: String
}
"""Location style mutations"""
type LocationStyleMutations {
"""Creates new location style"""
create(input: CreateLocationStyleInput!): CreateLocationStylePayload!
"""Updates existed location style"""
update(input: UpdateLocationStyleInput!): UpdateLocationStylePayload!
"""Deletes location style by id"""
delete(id: GlobalId!): DeleteLocationStylePayload!
}
"""Location type to add it to Location"""
type LocationType implements Node {
"""LocationType's ID"""
id: ID!
"""LocationTypes's name"""
name: String
}
"""
The `BigInt` scalar type represents non-fractional signed whole numeric values.
"""
scalar Long
"""
The `String` scalar type represents textual data, represented as UTF-8 character
sequences. The String type is most often used by GraphQL to represent free-form
human-readable text.
"""
scalar MultilingualString
"""API mutations"""
type Mutation {
"""Unused field to let extend this type"""
_: Boolean
person: PersonMutations
locationStyles: LocationStyleMutations!
location: LocationMutations!
locationInstances: LocationInstanceMutations!
relation: RelationMutations!
relationType: RelationTypeMutations!
quest: QuestMutations!
"""Mutations for users"""
user: UserMutations!
tag: TagMutations!
}
"""An object with a Globally Unique ID"""
interface Node {
"""The ID of the object."""
id: ID!
}
"""
A field whose value conforms with the standard mongodb object ID as described
here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId.
Example: 5e5677d71bdc2ae76344968c
"""
scalar ObjectId
"""Information about current page"""
type PageInfo {
"""Information about the existence of the next page"""
hasNextPage: Boolean!
"""Information about the existence of the previous page"""
hasPreviousPage: Boolean!
"""First cursor on this page"""
startCursor: Cursor
"""Last cursor on this page"""
endCursor: Cursor
}
type Person implements Node {
"""Person's id"""
id: ID!
"""Person's first name"""
firstName: MultilingualString
"""Person's last name"""
lastName: MultilingualString
"""Person's patronymic"""
patronymic: MultilingualString
"""Person's pseudonym"""
pseudonym: MultilingualString
"""Person's professions"""
professions: [String!]
"""Person's description"""
description: MultilingualString
"""Person's birth date"""
birthDate: String
"""Person's death date"""
deathDate: String
"""Person relations"""
relations: [Relation!]!
"""Person's info link"""
wikiLink: String
"""Person's main photo"""
mainPhotoLink: String
"""Link with photo for card"""
cardPhotoLink: String
"""Person's photos links"""
photoLinks: [String!]
"""Person tags"""
tags: [Tag!]!
}
"""Model for representing list of persons"""
type PersonConnection {
"""List of persons edges"""
edges: [PersonEdge!]!
"""Information about this page"""
pageInfo: PageInfo!
"""Number of available edges"""
totalCount: Int!
}
"""Information about specific person in connection"""
type PersonEdge {
"""Cursor of this person"""
cursor: Cursor!
"""Person info"""
node: Person!
}
type PersonMutations {
"""Create person"""
create(input: CreatePersonInput!): CreatePersonPayload!
"""Update person"""
update(input: UpdatePersonInput!): UpdatePersonPayload!
"""Delete person"""
delete(id: GlobalId!): DeletePersonPayload!
}
"""API queries"""
type Query {
node(id: ID!): Node
"""Get specific person"""
person(
"""Person id"""
id: GlobalId!
): Person
"""Get all persons"""
persons(
"""The cursor after which we take the data"""
after: Cursor
"""The cursor after before we take the data"""
before: Cursor
"""
Number of requested nodes after a node with a cursor in the after argument
"""
first: Int
"""
Number of requested nodes before a node with a cursor in the before argument
"""
last: Int
): PersonConnection!
personsCards: [Person!]!
"""Get specific location"""
location(
"""Location id"""
id: GlobalId!
): Location
"""Get all locations"""
locations(
"""The cursor after which we take the data"""
after: Cursor
"""The cursor after before we take the data"""
before: Cursor
"""
Number of requested nodes after a node with a cursor in the after argument
"""
first: Int
"""
Number of requested nodes before a node with a cursor in the before argument
"""
last: Int
): LocationConnection!
"""Get specific locationInstances"""
locationInstance(
"""locationInstances id"""
id: GlobalId!
): LocationInstance
"""Get all locationInstances"""
locationInstances: [LocationInstance!]!
"""Returns list of all location types"""
locationTypes: [LocationType!]!
"""Returns list of all location styles"""
locationStyles: [LocationStyle!]!
"""Get specific relation"""
relation(
"""Relation id"""
id: GlobalId!
): Relation
"""Get all relations"""
relations(
"""The cursor after which we take the data"""
after: Cursor
"""The cursor after before we take the data"""
before: Cursor
"""
Number of requested nodes after a node with a cursor in the after argument
"""
first: Int
"""
Number of requested nodes before a node with a cursor in the before argument
"""
last: Int
): RelationConnection!
"""Get specific relation type"""
relationType(
"""Relation type id"""
id: GlobalId!
): RelationType
"""List of available relation types"""
relationTypes(
"""The cursor after which we take the data"""
after: Cursor
"""The cursor after before we take the data"""
before: Cursor
"""
Number of requested nodes after a node with a cursor in the after argument
"""
first: Int
"""
Number of requested nodes before a node with a cursor in the before argument
"""
last: Int
): RelationTypeConnection!
"""Get info about user"""
me: User!
"""Get specific User"""
user(
"""User id"""
id: GlobalId!
): User
"""Returns connection with all users"""
users(
"""The cursor after which we take the data"""
after: Cursor
"""The cursor after before we take the data"""
before: Cursor
"""
Number of requested nodes after a node with a cursor in the after argument
"""
first: Int