forked from biocad/openapi3
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCommonTestTypes.hs
More file actions
1170 lines (1056 loc) · 26.1 KB
/
CommonTestTypes.hs
File metadata and controls
1170 lines (1056 loc) · 26.1 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
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE QuasiQuotes #-}
{-# LANGUAGE ScopedTypeVariables #-}
module Data.OpenApi.CommonTestTypes where
import Prelude ()
import Prelude.Compat
import Data.Aeson (FromJSON(..), ToJSON (..), ToJSONKey (..), Value)
import qualified Data.Aeson as Aeson
import qualified Data.Aeson.Types as Aeson
import Data.Aeson.QQ.Simple
import Data.Aeson.Types (toJSONKeyText)
import Data.Char
import Data.Map (Map)
import Data.Proxy
import Data.Set (Set)
import qualified Data.Text as Text
import Data.Word
import GHC.Generics
import Data.OpenApi
-- ========================================================================
-- Unit type
-- ========================================================================
data Unit = Unit deriving (Generic)
instance ToParamSchema Unit
instance ToSchema Unit
unitParamSchemaJSON :: Value
unitParamSchemaJSON = [aesonQQ|
{
"type": "string",
"enum": ["Unit"]
}
|]
unitSchemaJSON :: Value
unitSchemaJSON = [aesonQQ|
{
"type": "array",
"items": {},
"maxItems": 0,
"example": []
}
|]
data UnitTagged = UnitTagged
deriving (Generic)
instance ToSchema UnitTagged where
declareNamedSchema = genericDeclareNamedSchema
defaultSchemaOptions{Data.OpenApi.tagSingleConstructors = True}
instance FromJSON UnitTagged where
parseJSON = Aeson.genericParseJSON Aeson.defaultOptions{Aeson.tagSingleConstructors = True}
instance ToJSON UnitTagged where
toJSON = Aeson.genericToJSON Aeson.defaultOptions{Aeson.tagSingleConstructors = True}
unitTaggedSchemaJSON :: Value
unitTaggedSchemaJSON = [aesonQQ|
{
"enum":
[
"UnitTagged"
],
"type": "string"
}
|]
-- ========================================================================
-- Color (enum)
-- ========================================================================
data Color
= Red
| Green
| Blue
deriving (Generic)
instance ToParamSchema Color
instance ToSchema Color
colorSchemaJSON :: Value
colorSchemaJSON = [aesonQQ|
{
"type": "string",
"enum": ["Red", "Green", "Blue"]
}
|]
-- ========================================================================
-- Shade (paramSchemaToNamedSchema)
-- ========================================================================
data Shade = Dim | Bright deriving (Generic)
instance ToParamSchema Shade
instance ToSchema Shade where declareNamedSchema = pure . paramSchemaToNamedSchema defaultSchemaOptions
shadeSchemaJSON :: Value
shadeSchemaJSON = [aesonQQ|
{
"type": "string",
"enum": ["Dim", "Bright"]
}
|]
-- ========================================================================
-- Paint (record with bounded enum property)
-- ========================================================================
newtype Paint = Paint { color :: Color }
deriving (Generic)
instance ToSchema Paint
paintSchemaJSON :: Value
paintSchemaJSON = [aesonQQ|
{
"type": "object",
"properties":
{
"color":
{
"$ref": "#/components/schemas/Color"
}
},
"required": ["color"]
}
|]
paintInlinedSchemaJSON :: Value
paintInlinedSchemaJSON = [aesonQQ|
{
"type": "object",
"properties":
{
"color":
{
"type": "string",
"enum": ["Red", "Green", "Blue"]
}
},
"required": ["color"]
}
|]
-- ========================================================================
-- Status (constructorTagModifier)
-- ========================================================================
data Status
= StatusOk
| StatusError
deriving (Generic)
instance ToParamSchema Status where
toParamSchema = genericToParamSchema defaultSchemaOptions
{ constructorTagModifier = map toLower . drop (length "Status") }
instance ToSchema Status where
declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
{ constructorTagModifier = map toLower . drop (length "Status") }
statusSchemaJSON :: Value
statusSchemaJSON = [aesonQQ|
{
"type": "string",
"enum": ["ok", "error"]
}
|]
-- ========================================================================
-- Email (newtype with unwrapUnaryRecords set to True)
-- ========================================================================
newtype Email = Email { getEmail :: String }
deriving (Generic)
instance ToParamSchema Email
instance ToSchema Email where
declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
{ unwrapUnaryRecords = True }
emailSchemaJSON :: Value
emailSchemaJSON = [aesonQQ|
{
"type": "string"
}
|]
-- ========================================================================
-- UserId (non-record newtype)
-- ========================================================================
newtype UserId = UserId Integer
deriving (Eq, Ord, Generic)
instance ToParamSchema UserId
instance ToSchema UserId
userIdSchemaJSON :: Value
userIdSchemaJSON = [aesonQQ|
{
"type": "integer"
}
|]
-- ========================================================================
-- UserGroup (set newtype)
-- ========================================================================
newtype UserGroup = UserGroup (Set UserId)
deriving (Generic)
instance ToSchema UserGroup
userGroupSchemaJSON :: Value
userGroupSchemaJSON = [aesonQQ|
{
"type": "array",
"items": { "$ref": "#/components/schemas/UserId" },
"uniqueItems": true
}
|]
-- ========================================================================
-- Person (simple record with optional fields)
-- ========================================================================
data Person = Person
{ name :: String
, phone :: Integer
, email :: Maybe String
} deriving (Generic)
instance ToSchema Person
personSchemaJSON :: Value
personSchemaJSON = [aesonQQ|
{
"type": "object",
"properties":
{
"name": { "type": "string" },
"phone": { "type": "integer" },
"email":
{
"anyOf" :
[
{ "type" : "null" },
{ "type": "string" }
]
}
},
"required": ["name", "phone"]
}
|]
-- ========================================================================
-- Player (record newtype)
-- ========================================================================
newtype Player = Player
{ position :: Point
} deriving (Generic)
instance ToSchema Player
playerSchemaJSON :: Value
playerSchemaJSON = [aesonQQ|
{
"type": "object",
"properties":
{
"position":
{
"$ref": "#/components/schemas/Point"
}
},
"required": ["position"]
}
|]
newtype Players = Players [Inlined Player]
deriving (Generic)
instance ToSchema Players
playersSchemaJSON :: Value
playersSchemaJSON = [aesonQQ|
{
"type": "array",
"items":
{
"type": "object",
"properties":
{
"position":
{
"$ref": "#/components/schemas/Point"
}
},
"required": ["position"]
}
}
|]
-- ========================================================================
-- Character (sum type with ref and record in alternative)
-- ========================================================================
data Character
= PC Player
| NPC { npcName :: String, npcPosition :: Point }
deriving (Generic)
instance ToSchema Character
characterSchemaJSON :: Value
characterSchemaJSON = [aesonQQ|
{
"anyOf": [
{
"required": [
"tag",
"contents"
],
"title": "PC",
"type": "object",
"properties": {
"tag": {
"type": "string",
"enum": [
"PC"
]
},
"contents": {
"$ref": "#/components/schemas/Player"
}
}
},
{
"required": [
"npcName",
"npcPosition",
"tag"
],
"title": "NPC",
"type": "object",
"properties": {
"tag": {
"type": "string",
"enum": [
"NPC"
]
},
"npcPosition": {
"$ref": "#/components/schemas/Point"
},
"npcName": {
"type": "string"
}
}
}
]
}
|]
characterInlinedSchemaJSON :: Value
characterInlinedSchemaJSON = [aesonQQ|
{
"anyOf": [
{
"required": [
"tag",
"contents"
],
"title": "PC",
"type": "object",
"properties": {
"tag": {
"type": "string",
"enum": [
"PC"
]
},
"contents": {
"required": [
"position"
],
"type": "object",
"properties": {
"position": {
"required": [
"x",
"y"
],
"type": "object",
"properties": {
"x": {
"format": "double",
"type": "number"
},
"y": {
"format": "double",
"type": "number"
}
}
}
}
}
}
},
{
"required": [
"npcName",
"npcPosition",
"tag"
],
"title": "NPC",
"type": "object",
"properties": {
"tag": {
"type": "string",
"enum": [
"NPC"
]
},
"npcPosition": {
"required": [
"x",
"y"
],
"type": "object",
"properties": {
"x": {
"format": "double",
"type": "number"
},
"y": {
"format": "double",
"type": "number"
}
}
},
"npcName": {
"type": "string"
}
}
}
]
}
|]
characterInlinedPlayerSchemaJSON :: Value
characterInlinedPlayerSchemaJSON = [aesonQQ|
{
"anyOf": [
{
"required": [
"tag",
"contents"
],
"title": "PC",
"type": "object",
"properties": {
"tag": {
"type": "string",
"enum": [
"PC"
]
},
"contents": {
"required": [
"position"
],
"type": "object",
"properties": {
"position": {
"$ref": "#/components/schemas/Point"
}
}
}
}
},
{
"required": [
"npcName",
"npcPosition",
"tag"
],
"title": "NPC",
"type": "object",
"properties": {
"tag": {
"type": "string",
"enum": [
"NPC"
]
},
"npcPosition": {
"$ref": "#/components/schemas/Point"
},
"npcName": {
"type": "string"
}
}
}
]
}
|]
-- ========================================================================
-- ISPair (non-record product data type)
-- ========================================================================
data ISPair = ISPair Integer String
deriving (Generic)
instance ToSchema ISPair
ispairSchemaJSON :: Value
ispairSchemaJSON = [aesonQQ|
{
"type": "array",
"items":
[
{ "type": "integer" },
{ "type": "string" }
],
"minItems": 2,
"maxItems": 2
}
|]
-- ========================================================================
-- Point (record data type with custom fieldLabelModifier)
-- ========================================================================
data Point = Point
{ pointX :: Double
, pointY :: Double
} deriving (Generic)
instance ToSchema Point where
declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
{ fieldLabelModifier = map toLower . drop (length "point") }
pointSchemaJSON :: Value
pointSchemaJSON = [aesonQQ|
{
"type": "object",
"properties":
{
"x": { "type": "number", "format": "double" },
"y": { "type": "number", "format": "double" }
},
"required": ["x", "y"]
}
|]
-- ========================================================================
-- Point (record data type with multiple fields)
-- ========================================================================
data Point5 = Point5
{ point5X :: Double
, point5Y :: Double
, point5Z :: Double
, point5U :: Double
, point5V :: Double -- 5 dimensional!
} deriving (Generic)
instance ToSchema Point5 where
declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
{ fieldLabelModifier = map toLower . drop (length "point5") }
point5SchemaJSON :: Value
point5SchemaJSON = [aesonQQ|
{
"type": "object",
"properties":
{
"x": { "type": "number", "format": "double" },
"y": { "type": "number", "format": "double" },
"z": { "type": "number", "format": "double" },
"u": { "type": "number", "format": "double" },
"v": { "type": "number", "format": "double" }
},
"required": ["x", "y", "z", "u", "v"]
}
|]
point5Properties :: [String]
point5Properties = ["x", "y", "z", "u", "v"]
-- ========================================================================
-- MyRoseTree (custom datatypeNameModifier)
-- ========================================================================
data MyRoseTree = MyRoseTree
{ root :: String
, trees :: [MyRoseTree]
} deriving (Generic)
instance ToSchema MyRoseTree where
declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
{ datatypeNameModifier = drop (length "My") }
myRoseTreeSchemaJSON :: Value
myRoseTreeSchemaJSON = [aesonQQ|
{
"type": "object",
"properties":
{
"root": { "type": "string" },
"trees":
{
"type": "array",
"items":
{
"$ref": "#/components/schemas/RoseTree"
}
}
},
"required": ["root", "trees"]
}
|]
data MyRoseTree' = MyRoseTree'
{ root' :: String
, trees' :: [MyRoseTree']
} deriving (Generic)
instance ToSchema MyRoseTree' where
declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
{ datatypeNameModifier = map toLower }
myRoseTreeSchemaJSON' :: Value
myRoseTreeSchemaJSON' = [aesonQQ|
{
"type": "object",
"properties":
{
"root'": { "type": "string" },
"trees'":
{
"type": "array",
"items":
{
"$ref": "#/components/schemas/myrosetree'"
}
}
},
"required": ["root'", "trees'"]
}
|]
-- ========================================================================
-- Inlined (newtype for inlining schemas)
-- ========================================================================
newtype Inlined a = Inlined { getInlined :: a }
instance ToSchema a => ToSchema (Inlined a) where
declareNamedSchema _ = unname <$> declareNamedSchema (Proxy :: Proxy a)
where
unname (NamedSchema _ s) = NamedSchema Nothing s
-- ========================================================================
-- Light (sum type with unwrapUnaryRecords)
-- ========================================================================
data Light
= NoLight
| LightFreq Double
| LightColor Color
| LightWaveLength { waveLength :: Double }
deriving (Generic)
instance ToSchema Light where
declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
{ unwrapUnaryRecords = True }
lightSchemaJSON :: Value
lightSchemaJSON = [aesonQQ|
{
"anyOf": [
{
"required": [
"tag"
],
"title": "NoLight",
"type": "object",
"properties": {
"tag": {
"type": "string",
"enum": [
"NoLight"
]
}
}
},
{
"required": [
"tag",
"contents"
],
"title": "LightFreq",
"type": "object",
"properties": {
"tag": {
"type": "string",
"enum": [
"LightFreq"
]
},
"contents": {
"format": "double",
"type": "number"
}
}
},
{
"required": [
"tag",
"contents"
],
"title": "LightColor",
"type": "object",
"properties": {
"tag": {
"type": "string",
"enum": [
"LightColor"
]
},
"contents": {
"$ref": "#/components/schemas/Color"
}
}
},
{
"required": [
"waveLength",
"tag"
],
"title": "LightWaveLength",
"type": "object",
"properties": {
"tag": {
"type": "string",
"enum": [
"LightWaveLength"
]
},
"waveLength": {
"format": "double",
"type": "number"
}
}
}
]
}
|]
lightInlinedSchemaJSON :: Value
lightInlinedSchemaJSON = [aesonQQ|
{
"anyOf": [
{
"required": [
"tag"
],
"title": "NoLight",
"type": "object",
"properties": {
"tag": {
"type": "string",
"enum": [
"NoLight"
]
}
}
},
{
"required": [
"tag",
"contents"
],
"title": "LightFreq",
"type": "object",
"properties": {
"tag": {
"type": "string",
"enum": [
"LightFreq"
]
},
"contents": {
"format": "double",
"type": "number"
}
}
},
{
"required": [
"tag",
"contents"
],
"title": "LightColor",
"type": "object",
"properties": {
"tag": {
"type": "string",
"enum": [
"LightColor"
]
},
"contents": {
"type": "string",
"enum": [
"Red",
"Green",
"Blue"
]
}
}
},
{
"required": [
"waveLength",
"tag"
],
"title": "LightWaveLength",
"type": "object",
"properties": {
"tag": {
"type": "string",
"enum": [
"LightWaveLength"
]
},
"waveLength": {
"format": "double",
"type": "number"
}
}
}
]
}
|]
-- ========================================================================
-- ResourceId (series of newtypes)
-- ========================================================================
newtype Id = Id String deriving (Generic)
instance ToSchema Id
newtype ResourceId = ResourceId Id deriving (Generic)
instance ToSchema ResourceId
-- ========================================================================
-- ButtonImages (bounded enum key mapping)
-- ========================================================================
data ButtonState = Neutral | Focus | Active | Hover | Disabled
deriving (Show, Bounded, Enum, Generic)
instance ToJSON ButtonState
instance ToSchema ButtonState
instance ToJSONKey ButtonState where toJSONKey = toJSONKeyText (Text.pack . show)
type ImageUrl = Text.Text
newtype ButtonImages = ButtonImages { getButtonImages :: Map ButtonState ImageUrl }
deriving (Generic)
instance ToJSON ButtonImages where
toJSON = toJSON . getButtonImages
instance ToSchema ButtonImages where
declareNamedSchema = genericDeclareNamedSchemaNewtype defaultSchemaOptions
declareSchemaBoundedEnumKeyMapping
buttonImagesSchemaJSON :: Value
buttonImagesSchemaJSON = [aesonQQ|
{
"type": "object",
"properties":
{
"Neutral": { "type": "string" },
"Focus": { "type": "string" },
"Active": { "type": "string" },
"Hover": { "type": "string" },
"Disabled": { "type": "string" }
}
}
|]
-- ========================================================================
-- SingleMaybeField (single field data with optional field)
-- ========================================================================
data SingleMaybeField = SingleMaybeField { singleMaybeField :: Maybe String }
deriving (Show, Generic)
instance ToJSON SingleMaybeField
instance ToSchema SingleMaybeField
singleMaybeFieldSchemaJSON :: Value
singleMaybeFieldSchemaJSON = [aesonQQ|
{
"type": "object",
"properties":
{
"singleMaybeField":
{
"anyOf" :
[
{ "type" : "null" },
{ "type": "string" }
]
}
}
}
|]
-- ========================================================================
-- Natural Language (single field data with recursive fields)
-- ========================================================================
data Predicate
= PredicateNoun Noun
| PredicateOmitted Omitted
deriving (Eq, Ord, Read, Show, Generic)
instance ToJSON Predicate
instance ToSchema Predicate
data Noun
= Noun
{ nounSurf :: LangWord
, nounModify :: [Modifier]
}
deriving (Eq, Ord, Read, Show, Generic)
instance ToJSON Noun
instance ToSchema Noun
data LangWord
= LangWord
{ langWordSurf :: String
, langWordBase :: String
}
deriving (Eq, Ord, Read, Show, Generic)
instance ToJSON LangWord
instance ToSchema LangWord
data Modifier
= ModifierNoun Noun
| ModifierOmitted Omitted
deriving (Eq, Ord, Read, Show, Generic)
instance ToJSON Modifier
instance ToSchema Modifier
newtype Omitted
= Omitted
{ omittedModify :: [Modifier]
}
deriving (Eq, Ord, Read, Show, Generic)
instance ToJSON Omitted
instance ToSchema Omitted
predicateSchemaDeclareJSON :: Value
predicateSchemaDeclareJSON = [aesonQQ|
[
{
"Predicate": {
"anyOf": [
{
"properties": {
"contents": { "$ref": "#/components/schemas/Noun" },
"tag": { "enum": ["PredicateNoun"], "type": "string" }
},
"required": ["tag", "contents"],
"title": "PredicateNoun",
"type": "object"
},
{
"properties": {
"contents": { "$ref": "#/components/schemas/Omitted" },
"tag": { "enum": ["PredicateOmitted"], "type": "string" }
},
"required": ["tag", "contents"],
"title": "PredicateOmitted",
"type": "object"
}
]
},
"Noun": {
"properties": {
"nounModify": {
"items": { "$ref": "#/components/schemas/Modifier" },