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
//! Schema Object
use crate::common::bool_or::BoolOr;
use crate::common::formats::{IntegerFormat, NumberFormat, StringFormat};
use crate::common::helpers::{Context, ValidateWithContext, validate_pattern};
use crate::common::reference::RefOr;
use crate::v2::external_documentation::ExternalDocumentation;
use crate::v2::spec::Spec;
use crate::v2::xml::XML;
use monostate::MustBe;
use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;
use std::fmt::{Display, Formatter};
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
#[serde(untagged)]
pub enum Schema {
#[serde(rename = "string")]
String(StringSchema),
#[serde(rename = "integer")]
Integer(IntegerSchema),
#[serde(rename = "number")]
Number(NumberSchema),
#[serde(rename = "boolean")]
Boolean(BooleanSchema),
#[serde(rename = "array")]
Array(ArraySchema),
#[serde(rename = "null")]
Null(NullSchema),
#[serde(rename = "object")]
Object(ObjectSchema), // must be last
}
impl Default for Schema {
fn default() -> Self {
Schema::Object(ObjectSchema::default())
}
}
impl Display for Schema {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
match self {
Schema::String(_) => write!(f, "string"),
Schema::Integer(_) => write!(f, "integer"),
Schema::Number(_) => write!(f, "number"),
Schema::Boolean(_) => write!(f, "boolean"),
Schema::Array(_) => write!(f, "array"),
Schema::Object(_) => write!(f, "object"),
Schema::Null(_) => write!(f, "null"),
}
}
}
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Default)]
pub struct StringSchema {
#[serde(rename = "type")]
pub schema_type: MustBe!("string"),
/// A title to explain the purpose of the schema.
#[serde(skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// A short description of the schema.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// The extending format for the string type
#[serde(skip_serializing_if = "Option::is_none")]
pub format: Option<StringFormat>,
/// Declares the value of the header that the server will use if none is provided.
///
/// **Note**: "default" has no meaning for required headers.
#[serde(skip_serializing_if = "Option::is_none")]
pub default: Option<String>,
/// The list of strings that defines the possible values of this parameter.
#[serde(rename = "enum")]
#[serde(skip_serializing_if = "Option::is_none")]
pub enum_values: Option<Vec<String>>,
/// Declares the maximum length of the parameter value.
#[serde(rename = "maxLength")]
#[serde(skip_serializing_if = "Option::is_none")]
pub max_length: Option<u64>,
/// Declares the minimal length of the parameter value.
#[serde(rename = "minLength")]
#[serde(skip_serializing_if = "Option::is_none")]
pub min_length: Option<u64>,
/// A regular expression that the parameter value MUST match.
#[serde(skip_serializing_if = "Option::is_none")]
pub pattern: Option<String>,
/// Relevant only for Schema "properties" definitions.
/// Declares the property as "read only".
/// This means that it MAY be sent as part of a response but MUST NOT be sent as part of
/// the request.
/// Properties marked as readOnly being true SHOULD NOT be in the required list of
/// the defined schema.
/// Default value is `false`.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "readOnly")]
pub read_only: Option<bool>,
/// This MAY be used only on properties schemas.
/// It has no effect on root schemas.
/// Adds Additional metadata to describe the XML representation format of this property.
#[serde(skip_serializing_if = "Option::is_none")]
pub xml: Option<XML>,
/// Additional external documentation for this schema.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "externalDocs")]
pub external_docs: Option<ExternalDocumentation>,
/// A free-form property to include an example of an instance for this schema.
#[serde(skip_serializing_if = "Option::is_none")]
pub example: Option<serde_json::Value>,
/// Allows extensions to the Swagger Schema.
/// The field name MUST begin with `x-`, for example, `x-internal-id`.
/// The value can be null, a primitive, an array or an object.
#[serde(flatten)]
#[serde(with = "crate::common::extensions")]
#[serde(skip_serializing_if = "Option::is_none")]
pub extensions: Option<BTreeMap<String, serde_json::Value>>,
}
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Default)]
pub struct IntegerSchema {
#[serde(rename = "type")]
pub schema_type: MustBe!("integer"),
/// A title to explain the purpose of the schema.
#[serde(skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// A short description of the attribute.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// The extending format for the integer type
#[serde(skip_serializing_if = "Option::is_none")]
pub format: Option<IntegerFormat>,
/// Declares the value of the header that the server will use if none is provided.
///
/// **Note**: "default" has no meaning for required headers.
#[serde(skip_serializing_if = "Option::is_none")]
pub default: Option<i64>,
/// The list of strings that defines the possible values of this parameter.
#[serde(rename = "enum")]
#[serde(skip_serializing_if = "Option::is_none")]
pub enum_values: Option<Vec<i64>>,
/// Declares the minimum value of the parameter.
#[serde(skip_serializing_if = "Option::is_none")]
pub minimum: Option<i64>,
/// Declares that the value of the parameter is strictly greater than the value of `minimum`
#[serde(rename = "exclusiveMinimum")]
#[serde(skip_serializing_if = "Option::is_none")]
pub exclusive_minimum: Option<bool>,
/// Declares the minimum value of the parameter.
#[serde(skip_serializing_if = "Option::is_none")]
pub maximum: Option<i64>,
/// Declares that the value of the parameter is strictly less than the value of `maximum`
#[serde(rename = "exclusiveMaximum")]
#[serde(skip_serializing_if = "Option::is_none")]
pub exclusive_maximum: Option<bool>,
/// Declares that the value of the parameter can be restricted to a multiple of a given number
#[serde(rename = "multipleOf")]
#[serde(skip_serializing_if = "Option::is_none")]
pub multiple_of: Option<f64>,
/// Relevant only for Schema "properties" definitions.
/// Declares the property as "read only".
/// This means that it MAY be sent as part of a response but MUST NOT be sent as part of
/// the request.
/// Properties marked as readOnly being true SHOULD NOT be in the required list of
/// the defined schema.
/// Default value is `false`.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "readOnly")]
pub read_only: Option<bool>,
/// This MAY be used only on properties schemas.
/// It has no effect on root schemas.
/// Adds Additional metadata to describe the XML representation format of this property.
#[serde(skip_serializing_if = "Option::is_none")]
pub xml: Option<XML>,
/// Additional external documentation for this schema.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "externalDocs")]
pub external_docs: Option<ExternalDocumentation>,
/// A free-form property to include an example of an instance for this schema.
#[serde(skip_serializing_if = "Option::is_none")]
pub example: Option<serde_json::Value>,
/// Allows extensions to the Swagger Schema.
/// The field name MUST begin with `x-`, for example, `x-internal-id`.
/// The value can be null, a primitive, an array or an object.
#[serde(flatten)]
#[serde(with = "crate::common::extensions")]
#[serde(skip_serializing_if = "Option::is_none")]
pub extensions: Option<BTreeMap<String, serde_json::Value>>,
}
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Default)]
pub struct NumberSchema {
#[serde(rename = "type")]
pub schema_type: MustBe!("number"),
/// A title to explain the purpose of the schema.
#[serde(skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// A short description of the attribute.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// The extending format for the number type
#[serde(skip_serializing_if = "Option::is_none")]
pub format: Option<NumberFormat>,
/// Declares the value of the header that the server will use if none is provided.
///
/// **Note**: "default" has no meaning for required headers.
#[serde(skip_serializing_if = "Option::is_none")]
pub default: Option<f64>,
/// The list of strings that defines the possible values of this parameter.
#[serde(rename = "enum")]
#[serde(skip_serializing_if = "Option::is_none")]
pub enum_values: Option<Vec<f64>>,
/// Declares the minimum value of the parameter.
#[serde(skip_serializing_if = "Option::is_none")]
pub minimum: Option<f64>,
/// Declares that the value of the parameter is strictly greater than the value of `minimum`
#[serde(rename = "exclusiveMinimum")]
#[serde(skip_serializing_if = "Option::is_none")]
pub exclusive_minimum: Option<bool>,
/// Declares the minimum value of the parameter.
#[serde(skip_serializing_if = "Option::is_none")]
pub maximum: Option<f64>,
/// Declares that the value of the parameter is strictly less than the value of `maximum`
#[serde(rename = "exclusiveMaximum")]
#[serde(skip_serializing_if = "Option::is_none")]
pub exclusive_maximum: Option<bool>,
/// Declares that the value of the parameter can be restricted to a multiple of a given number
#[serde(rename = "multipleOf")]
#[serde(skip_serializing_if = "Option::is_none")]
pub multiple_of: Option<f64>,
/// Relevant only for Schema "properties" definitions.
/// Declares the property as "read only".
/// This means that it MAY be sent as part of a response but MUST NOT be sent as part of
/// the request.
/// Properties marked as readOnly being true SHOULD NOT be in the required list of
/// the defined schema.
/// Default value is `false`.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "readOnly")]
pub read_only: Option<bool>,
/// This MAY be used only on properties schemas.
/// It has no effect on root schemas.
/// Adds Additional metadata to describe the XML representation format of this property.
#[serde(skip_serializing_if = "Option::is_none")]
pub xml: Option<XML>,
/// Additional external documentation for this schema.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "externalDocs")]
pub external_docs: Option<ExternalDocumentation>,
/// A free-form property to include an example of an instance for this schema.
#[serde(skip_serializing_if = "Option::is_none")]
pub example: Option<serde_json::Value>,
/// Allows extensions to the Swagger Schema.
/// The field name MUST begin with `x-`, for example, `x-internal-id`.
/// The value can be null, a primitive, an array or an object.
#[serde(flatten)]
#[serde(with = "crate::common::extensions")]
#[serde(skip_serializing_if = "Option::is_none")]
pub extensions: Option<BTreeMap<String, serde_json::Value>>,
}
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Default)]
pub struct BooleanSchema {
#[serde(rename = "type")]
pub schema_type: MustBe!("boolean"),
/// A title to explain the purpose of the schema.
#[serde(skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// A short description of the attribute.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Declares the value of the header that the server will use if none is provided.
///
/// **Note**: "default" has no meaning for required headers.
#[serde(skip_serializing_if = "Option::is_none")]
pub default: Option<bool>,
/// Relevant only for Schema "properties" definitions.
/// Declares the property as "read only".
/// This means that it MAY be sent as part of a response but MUST NOT be sent as part of
/// the request.
/// Properties marked as readOnly being true SHOULD NOT be in the required list of
/// the defined schema.
/// Default value is `false`.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "readOnly")]
pub read_only: Option<bool>,
/// This MAY be used only on properties schemas.
/// It has no effect on root schemas.
/// Adds Additional metadata to describe the XML representation format of this property.
#[serde(skip_serializing_if = "Option::is_none")]
pub xml: Option<XML>,
/// Additional external documentation for this schema.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "externalDocs")]
pub external_docs: Option<ExternalDocumentation>,
/// A free-form property to include an example of an instance for this schema.
#[serde(skip_serializing_if = "Option::is_none")]
pub example: Option<serde_json::Value>,
/// Allows extensions to the Swagger Schema.
/// The field name MUST begin with `x-`, for example, `x-internal-id`.
/// The value can be null, a primitive, an array or an object.
#[serde(flatten)]
#[serde(with = "crate::common::extensions")]
#[serde(skip_serializing_if = "Option::is_none")]
pub extensions: Option<BTreeMap<String, serde_json::Value>>,
}
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Default)]
pub struct ArraySchema {
#[serde(rename = "type")]
pub schema_type: MustBe!("array"),
/// A title to explain the purpose of the schema.
#[serde(skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// A short description of the attribute.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// **Required** Describes the type of items in the array.
#[serde(skip_serializing_if = "Option::is_none")]
pub items: Option<RefOr<Box<Schema>>>,
/// Declares the values of the header that the server will use if none is provided.
#[serde(skip_serializing_if = "Option::is_none")]
pub default: Option<Vec<serde_json::Value>>,
// Declares the maximum number of items that are allowed in the array.
#[serde(rename = "maxItems")]
#[serde(skip_serializing_if = "Option::is_none")]
pub max_items: Option<u64>,
// Declares the minimum number of items that are allowed in the array.
#[serde(rename = "minItems")]
#[serde(skip_serializing_if = "Option::is_none")]
pub min_items: Option<u64>,
// Declares the items in the array must be unique.
#[serde(rename = "uniqueItems")]
#[serde(skip_serializing_if = "Option::is_none")]
pub unique_items: Option<bool>,
/// Relevant only for Schema "properties" definitions.
/// Declares the property as "read only".
/// This means that it MAY be sent as part of a response but MUST NOT be sent as part of
/// the request.
/// Properties marked as readOnly being true SHOULD NOT be in the required list of
/// the defined schema.
/// Default value is `false`.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "readOnly")]
pub read_only: Option<bool>,
/// This MAY be used only on properties schemas.
/// It has no effect on root schemas.
/// Adds Additional metadata to describe the XML representation format of this property.
#[serde(skip_serializing_if = "Option::is_none")]
pub xml: Option<XML>,
/// Additional external documentation for this schema.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "externalDocs")]
pub external_docs: Option<ExternalDocumentation>,
/// A free-form property to include an example of an instance for this schema.
#[serde(skip_serializing_if = "Option::is_none")]
pub example: Option<serde_json::Value>,
/// Allows extensions to the Swagger Schema.
/// The field name MUST begin with `x-`, for example, `x-internal-id`.
/// The value can be null, a primitive, an array or an object.
#[serde(flatten)]
#[serde(with = "crate::common::extensions")]
#[serde(skip_serializing_if = "Option::is_none")]
pub extensions: Option<BTreeMap<String, serde_json::Value>>,
}
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Default)]
pub struct ObjectSchema {
#[serde(rename = "type")]
pub schema_type: MustBe!("object"),
/// A title to explain the purpose of the schema.
#[serde(skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// A short description of the attribute.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Describes the properties in the object.
#[serde(skip_serializing_if = "Option::is_none")]
pub properties: Option<BTreeMap<String, RefOr<Box<Schema>>>>,
/// Declares the values of the header that the server will use if none is provided.
#[serde(skip_serializing_if = "Option::is_none")]
pub default: Option<Vec<serde_json::Value>>,
/// Declares the maximum number of items that are allowed in the array.
#[serde(rename = "maxProperties")]
#[serde(skip_serializing_if = "Option::is_none")]
pub max_properties: Option<u64>,
/// Declares the minimum number of items that are allowed in the array.
#[serde(rename = "minProperties")]
#[serde(skip_serializing_if = "Option::is_none")]
pub min_properties: Option<u64>,
/// Declares the properties whose names are not listed in the `properties`
#[serde(rename = "additionalProperties")]
#[serde(skip_serializing_if = "Option::is_none")]
pub additional_properties: Option<BoolOr<RefOr<Box<Schema>>>>,
/// A list of required properties.
/// If the object is defined at the root of the document,
/// the `required` property MUST be omitted.
#[serde(skip_serializing_if = "Option::is_none")]
pub required: Option<Vec<String>>,
/// Adds support for polymorphism.
/// The discriminator is the schema property name that is used to differentiate between
/// other schema that inherit this schema.
/// The property name used MUST be defined at this schema and it MUST be in the required
/// property list.
/// When used, the value MUST be the name of this schema or any schema that inherits it.
#[serde(skip_serializing_if = "Option::is_none")]
pub discriminator: Option<String>,
/// Relevant only for Schema "properties" definitions.
/// Declares the property as "read only".
/// This means that it MAY be sent as part of a response but MUST NOT be sent as part of
/// the request.
/// Properties marked as readOnly being true SHOULD NOT be in the required list of
/// the defined schema.
/// Default value is `false`.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "readOnly")]
pub read_only: Option<bool>,
/// This MAY be used only on properties schemas.
/// It has no effect on root schemas.
/// Adds Additional metadata to describe the XML representation format of this property.
#[serde(skip_serializing_if = "Option::is_none")]
pub xml: Option<XML>,
/// Additional external documentation for this schema.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "externalDocs")]
pub external_docs: Option<ExternalDocumentation>,
/// A free-form property to include an example of an instance for this schema.
#[serde(skip_serializing_if = "Option::is_none")]
pub example: Option<serde_json::Value>,
/// Takes an array of object definitions that are validated independently
/// but together compose a single object
#[serde(rename = "allOf")]
#[serde(skip_serializing_if = "Option::is_none")]
pub all_of: Option<Vec<RefOr<ObjectSchema>>>,
/// Allows extensions to the Swagger Schema.
/// The field name MUST begin with `x-`, for example, `x-internal-id`.
/// The value can be null, a primitive, an array or an object.
#[serde(flatten)]
#[serde(with = "crate::common::extensions")]
#[serde(skip_serializing_if = "Option::is_none")]
pub extensions: Option<BTreeMap<String, serde_json::Value>>,
}
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Default)]
pub struct NullSchema {
#[serde(rename = "type")]
pub schema_type: MustBe!("null"),
/// A title to explain the purpose of the schema.
#[serde(skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// A short description of the attribute.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Relevant only for Schema "properties" definitions.
/// Declares the property as "read only".
/// This means that it MAY be sent as part of a response but MUST NOT be sent as part of
/// the request.
/// Properties marked as readOnly being true SHOULD NOT be in the required list of
/// the defined schema.
/// Default value is `false`.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "readOnly")]
pub read_only: Option<bool>,
/// This MAY be used only on properties schemas.
/// It has no effect on root schemas.
/// Adds Additional metadata to describe the XML representation format of this property.
#[serde(skip_serializing_if = "Option::is_none")]
pub xml: Option<XML>,
/// Additional external documentation for this schema.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "externalDocs")]
pub external_docs: Option<ExternalDocumentation>,
/// A free-form property to include an example of an instance for this schema.
#[serde(skip_serializing_if = "Option::is_none")]
pub example: Option<serde_json::Value>,
/// Allows extensions to the Swagger Schema.
/// The field name MUST begin with `x-`, for example, `x-internal-id`.
/// The value can be null, a primitive, an array or an object.
#[serde(flatten)]
#[serde(with = "crate::common::extensions")]
#[serde(skip_serializing_if = "Option::is_none")]
pub extensions: Option<BTreeMap<String, serde_json::Value>>,
}
impl ValidateWithContext<Spec> for Schema {
fn validate_with_context(&self, ctx: &mut Context<Spec>, path: String) {
match self {
Schema::String(s) => s.validate_with_context(ctx, path),
Schema::Integer(s) => s.validate_with_context(ctx, path),
Schema::Number(s) => s.validate_with_context(ctx, path),
Schema::Boolean(s) => s.validate_with_context(ctx, path),
Schema::Array(s) => s.validate_with_context(ctx, path),
Schema::Object(s) => s.validate_with_context(ctx, path),
Schema::Null(s) => s.validate_with_context(ctx, path),
}
}
}
impl ValidateWithContext<Spec> for StringSchema {
fn validate_with_context(&self, ctx: &mut Context<Spec>, path: String) {
if let Some(docs) = &self.external_docs {
docs.validate_with_context(ctx, format!("{path}.externalDocs"));
}
if let Some(xml) = &self.xml {
xml.validate_with_context(ctx, format!("{path}.xml"));
}
if let Some(pattern) = &self.pattern {
validate_pattern(pattern, ctx, format!("{path}.pattern"));
}
}
}
impl ValidateWithContext<Spec> for IntegerSchema {
fn validate_with_context(&self, ctx: &mut Context<Spec>, path: String) {
if let Some(docs) = &self.external_docs {
docs.validate_with_context(ctx, format!("{path}.externalDocs"));
}
if let Some(xml) = &self.xml {
xml.validate_with_context(ctx, format!("{path}.xml"));
}
}
}
impl ValidateWithContext<Spec> for NumberSchema {
fn validate_with_context(&self, ctx: &mut Context<Spec>, path: String) {
if let Some(docs) = &self.external_docs {
docs.validate_with_context(ctx, format!("{path}.externalDocs"));
}
if let Some(xml) = &self.xml {
xml.validate_with_context(ctx, format!("{path}.xml"));
}
}
}
impl ValidateWithContext<Spec> for BooleanSchema {
fn validate_with_context(&self, ctx: &mut Context<Spec>, path: String) {
if let Some(docs) = &self.external_docs {
docs.validate_with_context(ctx, format!("{path}.externalDocs"));
}
if let Some(xml) = &self.xml {
xml.validate_with_context(ctx, format!("{path}.xml"));
}
}
}
impl ValidateWithContext<Spec> for ArraySchema {
fn validate_with_context(&self, ctx: &mut Context<Spec>, path: String) {
if let Some(docs) = &self.external_docs {
docs.validate_with_context(ctx, format!("{path}.externalDocs"));
}
if let Some(xml) = &self.xml {
xml.validate_with_context(ctx, format!("{path}.xml"));
}
if let Some(items) = &self.items {
items.validate_with_context_boxed(ctx, format!("{path}.items"));
}
}
}
impl ValidateWithContext<Spec> for ObjectSchema {
fn validate_with_context(&self, ctx: &mut Context<Spec>, path: String) {
if let Some(docs) = &self.external_docs {
docs.validate_with_context(ctx, format!("{path}.externalDocs"));
}
if let Some(xml) = &self.xml {
xml.validate_with_context(ctx, format!("{path}.xml"));
}
if let Some(properties) = &self.properties {
for (name, schema) in properties {
schema.validate_with_context_boxed(ctx, format!("{path}.properties.{name}"));
}
}
if let Some(additional_properties) = &self.additional_properties {
match additional_properties {
BoolOr::Bool(_) => {}
BoolOr::Item(schema) => {
schema.validate_with_context_boxed(ctx, format!("{path}.additionalProperties"));
}
}
}
if let Some(all_of) = &self.all_of {
for (i, schema) in all_of.iter().enumerate() {
schema.validate_with_context(ctx, format!("{path}.allOf[{i}]"));
}
}
}
}
impl ValidateWithContext<Spec> for NullSchema {
fn validate_with_context(&self, ctx: &mut Context<Spec>, path: String) {
if let Some(docs) = &self.external_docs {
docs.validate_with_context(ctx, format!("{path}.externalDocs"));
}
if let Some(xml) = &self.xml {
xml.validate_with_context(ctx, format!("{path}.xml"));
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_single_deserialize() {
let spec = serde_json::from_value::<Schema>(serde_json::json!({
"type": "string",
"title": "foo",
}))
.unwrap();
if let Schema::String(ref string) = spec {
assert_eq!(string.title, Some("foo".to_owned()));
} else {
panic!("expected StringSchema");
}
assert_eq!(
spec,
Schema::String(StringSchema {
title: Some("foo".to_owned()),
..Default::default()
}),
);
}
#[test]
fn test_all_of_deserialize() {
let spec = serde_json::from_value::<Schema>(serde_json::json!({
"allOf": [
{
"$ref": "#/definitions/bar"
},
{
"type": "object",
"title": "foo",
},
],
"type": "object",
}))
.unwrap();
if let Schema::Object(schema) = spec.clone() {
if let Some(all_of) = schema.all_of {
assert_eq!(all_of.len(), 2);
match all_of[0].clone() {
RefOr::Ref(r) => {
assert_eq!(r.reference, "#/definitions/bar".to_owned());
}
_ => panic!("expected Ref"),
}
match all_of[1].clone() {
RefOr::Item(o) => {
assert_eq!(o.title, Some("foo".to_owned()));
}
_ => panic!("expected Schema"),
}
} else {
panic!("expected all_of to be set");
}
} else {
panic!("expected ObjectSchema");
}
}
#[test]
fn test_single_serialize() {
assert_eq!(
serde_json::to_value(Schema::String(StringSchema {
title: Some("foo".to_owned()),
..Default::default()
}))
.unwrap(),
serde_json::json!({
"type": "string",
"title": "foo",
}),
);
assert_eq!(
serde_json::to_value(Schema::Object(ObjectSchema {
title: Some("foo".to_owned()),
required: Some(vec!["bar".to_owned()]),
properties: Some({
let mut map = BTreeMap::new();
map.insert(
"bar".to_owned(),
RefOr::new_item(Box::new(Schema::String(StringSchema {
title: Some("foo bar".to_owned()),
..Default::default()
}))),
);
map
}),
..Default::default()
}))
.unwrap(),
serde_json::json!({
"type": "object",
"title": "foo",
"required": ["bar"],
"properties": {
"bar": {
"type": "string",
"title": "foo bar",
},
},
}),
);
}
#[test]
fn test_all_of_serialize() {
assert_eq!(
serde_json::to_value(Schema::Object(ObjectSchema {
all_of: Some(vec![
RefOr::new_ref("#/definitions/bar".to_owned()),
RefOr::new_item(ObjectSchema {
title: Some("foo".to_owned()),
..Default::default()
}),
]),
..Default::default()
}))
.unwrap(),
serde_json::json!({
"type": "object",
"allOf": [
{
"$ref": "#/definitions/bar"
},
{
"title": "foo",
"type": "object",
},
],
}),
);
}
}