Skip to main content

oag_core/parse/
schema.rs

1use indexmap::IndexMap;
2use serde::{Deserialize, Serialize};
3
4/// A JSON Schema type keyword value.
5#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
6#[serde(rename_all = "lowercase")]
7pub enum SchemaType {
8    String,
9    Number,
10    Integer,
11    Boolean,
12    Array,
13    Object,
14    Null,
15}
16
17/// The `type` field can be a single type or an array of types.
18#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
19#[serde(untagged)]
20pub enum TypeSet {
21    Single(SchemaType),
22    Multiple(Vec<SchemaType>),
23}
24
25/// A reference or inline schema.
26#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
27#[serde(untagged)]
28pub enum SchemaOrRef {
29    Ref {
30        #[serde(rename = "$ref")]
31        ref_path: String,
32    },
33    Schema(Box<Schema>),
34}
35
36/// Discriminator for polymorphic schemas.
37#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
38pub struct Discriminator {
39    #[serde(rename = "propertyName")]
40    pub property_name: String,
41    #[serde(default, skip_serializing_if = "IndexMap::is_empty")]
42    pub mapping: IndexMap<String, String>,
43}
44
45/// A JSON Schema object (OpenAPI 3.2 superset).
46#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
47pub struct Schema {
48    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
49    pub schema_type: Option<TypeSet>,
50
51    #[serde(skip_serializing_if = "Option::is_none")]
52    pub format: Option<String>,
53
54    #[serde(skip_serializing_if = "Option::is_none")]
55    pub title: Option<String>,
56
57    #[serde(skip_serializing_if = "Option::is_none")]
58    pub description: Option<String>,
59
60    #[serde(rename = "default", skip_serializing_if = "Option::is_none")]
61    pub default_value: Option<serde_json::Value>,
62
63    #[serde(skip_serializing_if = "Option::is_none")]
64    pub nullable: Option<bool>,
65
66    // Object properties
67    #[serde(default, skip_serializing_if = "IndexMap::is_empty")]
68    pub properties: IndexMap<String, SchemaOrRef>,
69
70    #[serde(default, skip_serializing_if = "Vec::is_empty")]
71    pub required: Vec<String>,
72
73    #[serde(
74        rename = "additionalProperties",
75        skip_serializing_if = "Option::is_none"
76    )]
77    pub additional_properties: Option<AdditionalProperties>,
78
79    // Array items
80    #[serde(skip_serializing_if = "Option::is_none")]
81    pub items: Option<Box<SchemaOrRef>>,
82
83    // Composition
84    #[serde(rename = "allOf", default, skip_serializing_if = "Vec::is_empty")]
85    pub all_of: Vec<SchemaOrRef>,
86
87    #[serde(rename = "oneOf", default, skip_serializing_if = "Vec::is_empty")]
88    pub one_of: Vec<SchemaOrRef>,
89
90    #[serde(rename = "anyOf", default, skip_serializing_if = "Vec::is_empty")]
91    pub any_of: Vec<SchemaOrRef>,
92
93    #[serde(skip_serializing_if = "Option::is_none")]
94    pub discriminator: Option<Discriminator>,
95
96    // Enum values
97    #[serde(rename = "enum", default, skip_serializing_if = "Vec::is_empty")]
98    pub enum_values: Vec<serde_json::Value>,
99
100    // Numeric constraints
101    #[serde(skip_serializing_if = "Option::is_none")]
102    pub minimum: Option<f64>,
103    #[serde(skip_serializing_if = "Option::is_none")]
104    pub maximum: Option<f64>,
105    #[serde(rename = "exclusiveMinimum", skip_serializing_if = "Option::is_none")]
106    pub exclusive_minimum: Option<f64>,
107    #[serde(rename = "exclusiveMaximum", skip_serializing_if = "Option::is_none")]
108    pub exclusive_maximum: Option<f64>,
109
110    // String constraints
111    #[serde(rename = "minLength", skip_serializing_if = "Option::is_none")]
112    pub min_length: Option<u64>,
113    #[serde(rename = "maxLength", skip_serializing_if = "Option::is_none")]
114    pub max_length: Option<u64>,
115    #[serde(skip_serializing_if = "Option::is_none")]
116    pub pattern: Option<String>,
117
118    // Array constraints
119    #[serde(rename = "minItems", skip_serializing_if = "Option::is_none")]
120    pub min_items: Option<u64>,
121    #[serde(rename = "maxItems", skip_serializing_if = "Option::is_none")]
122    pub max_items: Option<u64>,
123    #[serde(rename = "uniqueItems", skip_serializing_if = "Option::is_none")]
124    pub unique_items: Option<bool>,
125
126    // Read/Write only
127    #[serde(rename = "readOnly", skip_serializing_if = "Option::is_none")]
128    pub read_only: Option<bool>,
129    #[serde(rename = "writeOnly", skip_serializing_if = "Option::is_none")]
130    pub write_only: Option<bool>,
131
132    // Const
133    #[serde(rename = "const", skip_serializing_if = "Option::is_none")]
134    pub const_value: Option<serde_json::Value>,
135
136    // Example
137    #[serde(skip_serializing_if = "Option::is_none")]
138    pub example: Option<serde_json::Value>,
139}
140
141/// `additionalProperties` can be a boolean or a schema.
142#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
143#[serde(untagged)]
144pub enum AdditionalProperties {
145    Bool(bool),
146    Schema(Box<SchemaOrRef>),
147}