Function interactive_parse::parse_schema
source · pub fn parse_schema(
definitions: &BTreeMap<String, Schema>,
title: Option<String>,
name: String,
schema: SchemaObject
) -> SchemaResult<Value>Examples found in repository?
src/traits.rs (line 27)
18 19 20 21 22 23 24 25 26 27 28 29
fn parse_to_val() -> SchemaResult<Value> {
let root_schema = schema_for!(T);
let name = String::default();
let mut title = None;
if let Some(metadata) = &root_schema.schema.metadata {
if let Some(title_ref) = &metadata.title {
title = Some(title_ref.clone());
}
}
let value = parse_schema(&root_schema.definitions, title, name, root_schema.schema)?;
Ok(value)
}More examples
src/lib.rs (lines 60-65)
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
pub fn parse_schema(
definitions: &BTreeMap<String, Schema>,
title: Option<String>,
name: String,
schema: SchemaObject,
) -> SchemaResult<Value> {
let description = get_description(&schema);
match schema.instance_type.clone() {
Some(SingleOrVec::Single(instance_type)) => get_single_instance(
definitions,
schema.array,
schema.object,
schema.subschemas,
instance_type,
title,
name,
description,
),
Some(SingleOrVec::Vec(vec)) => {
// This usually represents an optional regular type
// Probably not a great assumption.
let instance_type =
Box::new(vec.into_iter().find(|x| x != &InstanceType::Null).unwrap());
if Confirm::new("Add optional value?")
.with_help_message(format!("{}{}", get_title_str(&title), name).as_str())
.prompt()?
{
get_single_instance(
definitions,
schema.array,
schema.object,
schema.subschemas,
instance_type,
title,
name,
description,
)
} else {
Ok(Value::Null)
}
}
None => {
// This represents a referenced type
if let Some(reference) = schema.reference {
let reference = reference.strip_prefix("#/definitions/").unwrap();
let schema = definitions.get(reference).unwrap();
let schema = get_schema_object_ref(schema)?;
parse_schema(
definitions,
Some(reference.to_string()),
name,
schema.clone(),
)
}
// Or it could be a subschema
else {
get_subschema(definitions, title, name, schema.subschemas, description)
}
}
}
}
fn update_title(mut title: Option<String>, schema: &SchemaObject) -> Option<String> {
if let Some(metadata) = &schema.metadata {
title = metadata.title.clone();
}
title
}
fn get_title_str(title: &Option<String>) -> String {
let mut title_str = String::new();
if let Some(title) = title {
title_str.push_str(format!("<{}> ", title).as_str());
}
title_str
}
fn get_description(schema: &SchemaObject) -> String {
match &schema.metadata {
Some(metadata) => match &metadata.description {
Some(description_ref) => {
let mut description = description_ref.clone();
if description.len() > 60 {
description.truncate(60);
description.push_str("...");
}
format!(": {}", description)
}
None => String::default(),
},
None => String::default(),
}
}
#[allow(clippy::too_many_arguments)]
#[allow(clippy::boxed_local)]
fn get_single_instance(
definitions: &BTreeMap<String, Schema>,
array_info: Option<Box<ArrayValidation>>,
object_info: Option<Box<ObjectValidation>>,
subschema: Option<Box<SubschemaValidation>>,
instance: Box<InstanceType>,
title: Option<String>,
name: String,
description: String,
) -> SchemaResult<Value> {
match *instance {
InstanceType::String => get_string(name, description),
InstanceType::Number => get_num(name, description),
InstanceType::Integer => get_int(name, description),
InstanceType::Boolean => get_bool(name, description),
InstanceType::Array => get_array(definitions, array_info, title, name, description),
InstanceType::Object => get_object(definitions, object_info, title, name, description),
InstanceType::Null => {
// This represents an optional enum
// Likely the subschema will have info here.
get_subschema(definitions, title, name, subschema, description)
}
}
}
fn get_subschema(
definitions: &BTreeMap<String, Schema>,
title: Option<String>,
name: String,
subschema: Option<Box<SubschemaValidation>>,
description: String,
) -> SchemaResult<Value> {
let subschema = subschema.unwrap();
// First we check the one_of field.
if let Some(schema_vec) = subschema.one_of {
let mut options = Vec::new();
for schema in &schema_vec {
let Schema::Object(schema_object) = schema else {
panic!("invalid schema");
};
let name = match schema_object.clone().object {
Some(mut object) => object.properties.pop_first().unwrap().0,
None => "None".into(),
};
options.push(name);
}
let option = Select::new("Select one:", options.clone())
.with_help_message(
format!("{}{}{}", get_title_str(&title), name, description.as_str()).as_str(),
)
.prompt()?;
let position = options.iter().position(|x| x == &option).unwrap();
let object = get_schema_object(schema_vec[position].clone())?;
let title = update_title(title, &object);
Ok(parse_schema(definitions, title, name, object)?)
}
// Next check the all_of field.
else if let Some(schema_vec) = subschema.all_of {
let mut values = Vec::new();
for schema in schema_vec {
let object = get_schema_object(schema)?;
let title = update_title(title.clone(), &object);
values.push(parse_schema(
definitions,
title.clone(),
name.clone(),
object,
)?)
}
match values.len() {
1 => Ok(values.pop().unwrap()),
_ => Ok(Value::Array(values)),
}
}
// Next check the any_of field.
// This seems to be a weird way to get options
else if let Some(schema_vec) = subschema.any_of {
let non_null = schema_vec
.into_iter()
.find(|x| {
let Schema::Object(object) = x else {
panic!("invalid schema");
};
object.instance_type != Some(SingleOrVec::Single(Box::new(InstanceType::Null)))
})
.unwrap();
let Schema::Object(object) = non_null else {
panic!("invalid schema");
};
let title = update_title(title, &object);
if Confirm::new("Add optional value?")
.with_help_message(format!("{}{}", get_title_str(&title), name).as_str())
.prompt()?
{
parse_schema(definitions, title, name, object)
} else {
Ok(Value::Null)
}
} else {
panic!("invalid schema");
}
}
fn get_int(name: String, description: String) -> SchemaResult<Value> {
Ok(json!(CustomType::<i64>::new(name.as_str())
.with_help_message(format!("int{}", description).as_str())
.prompt()?))
}
fn get_string(name: String, description: String) -> SchemaResult<Value> {
Ok(Value::String(
Text::new(name.as_str())
.with_help_message(format!("string{}", description).as_str())
.prompt()?,
))
}
fn get_num(name: String, description: String) -> SchemaResult<Value> {
Ok(json!(CustomType::<f64>::new(name.as_str())
.with_help_message(format!("num{}", description).as_str())
.prompt()?))
}
fn get_bool(name: String, description: String) -> SchemaResult<Value> {
Ok(json!(CustomType::<bool>::new(name.as_str())
.with_help_message(format!("bool{}", description).as_str())
.prompt()?))
}
fn get_array(
definitions: &BTreeMap<String, Schema>,
array_info: Option<Box<ArrayValidation>>,
title: Option<String>,
name: String,
description: String,
) -> SchemaResult<Value> {
let array_info = array_info.unwrap();
let mut array = Vec::new();
let range = array_info.min_items..array_info.max_items;
let schemas = match array_info.items.unwrap() {
SingleOrVec::Single(single) => {
vec![*single]
}
SingleOrVec::Vec(vec) => vec,
};
for (i, schema) in schemas.into_iter().enumerate() {
let object = get_schema_object(schema)?;
if let Some(end) = range.end {
if array.len() == end as usize {
break;
}
}
let start = range.start.unwrap_or_default();
if array.len() >= start as usize
&& !Confirm::new("Add element?")
.with_help_message(
format!("{}{}{}", get_title_str(&title), name, description).as_str(),
)
.prompt()?
{
break;
}
array.push(parse_schema(
definitions,
title.clone(),
format!("{}.{}", name.clone(), i),
object.clone(),
)?);
}
Ok(Value::Array(array))
}
fn get_object(
definitions: &BTreeMap<String, Schema>,
object_info: Option<Box<ObjectValidation>>,
title: Option<String>,
_name: String,
_description: String,
) -> SchemaResult<Value> {
let map = object_info
.unwrap()
.properties
.into_iter()
.map(|(name, schema)| {
let schema_object = get_schema_object(schema)?;
let object = parse_schema(definitions, title.clone(), name.to_string(), schema_object)?;
Ok((name, object))
})
.collect::<SchemaResult<Map<String, Value>>>()?;
Ok(Value::Object(map))
}