impl JsonSchema for basic camino types

[dbanty]

I'd like to be able to use Utf8Path and Utf8PathBuf like the std equivalents when deriving JsonSchema. I believe the implementation is the same as for those types over in primitives.

There should be a camino feature that gates this based on the optional dependency.

[AzHicham]

Is this gonna be merged soon ?
TBH We use a lot Utf8PathBuf instead of PathBuf in our apps.
And since we are planning to migrate to axum and use aide (OpenApi/Swagger) we absolutely need this feature.

[aidanwolter3]

I am also looking forward to when this will merge. We use Utf8PathBuf all over the place which prevents me from using schemars until this is merged in.

[sunshowers]

(camino maintainer here)

Meanwhile, you can use this really simple impl:

fn path_schema(gen: &mut SchemaGenerator) -> Schema {
    let mut schema: SchemaObject = <String>::json_schema(gen).into();
    schema.format = Some("Utf8PathBuf".to_owned());
    schema.into()
}

and annotate your schemas with #[schemars(schema_with = "path_schema")].

You can do something similar for Option<Utf8PathBuf>, Vec<Utf8PathBuf> etc.

This is too trivial to be copyrightable, but in case it ever is, consider this to be CC0-1.0.

[sunshowers]

So hmmmm...

I think this shouldn't be String, I believe -- it should be something more specific like Utf8PathBuf.

This goes into the format field in the OpenAPI and JSON schema spec. There are some defined formats, but otherwise it's an open universe (based on https://swagger.io/docs/specification/data-models/data-types/ and https://json-schema.org/understanding-json-schema/reference/string#format).

But maybe this should be exposed as a custom field on the side, e.g. x-rust-type. @ahl do you have thoughts?

[aidanwolter3]

sunshowers's comment works for me! Thank you @sunshowers .