Fix #[schemars(with = ...)] alongside #[serde(transparent)] (#67)

Co-authored-by: Graham Esau <gesau@hotmail.co.uk>
This commit is contained in:
David Hotham 2021-03-21 13:56:24 +00:00 committed by GitHub
parent 1c9ecafd32
commit c4ef7bad22
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 43 additions and 26 deletions

View file

@ -6,10 +6,11 @@
### Changed: ### Changed:
- Minimum supported rust version is now 1.37.0 - Minimum supported rust version is now 1.37.0
### Changed:
- Deriving JsonSchema on enums now sets `additionalProperties` to false on generated schemas wherever serde doesn't accept unknown properties. This includes non-unit variants of externally tagged enums, and struct-style variants of all enums that have the `deny_unknown_fields` attribute. - Deriving JsonSchema on enums now sets `additionalProperties` to false on generated schemas wherever serde doesn't accept unknown properties. This includes non-unit variants of externally tagged enums, and struct-style variants of all enums that have the `deny_unknown_fields` attribute.
### Fixed
- Fix use of `#[serde(transparent)]` in combination with `#[schemars(with = ...)]` (https://github.com/GREsau/schemars/pull/67)
## [0.8.0] - 2020-09-27 ## [0.8.0] - 2020-09-27
### Added: ### Added:
- `visit::Visitor`, a trait for updating a schema and all schemas it contains recursively. A `SchemaSettings` can now contain a list of visitors. - `visit::Visitor`, a trait for updating a schema and all schemas it contains recursively. A `SchemaSettings` can now contain a list of visitors.
@ -128,4 +129,4 @@
- Made prepositions/conjunctions in generated schema names lowercase - Made prepositions/conjunctions in generated schema names lowercase
- e.g. schema name for `Result<MyStruct, Vec<String>>` has changed from "Result_Of_MyStruct_Or_Array_Of_String" to "Result_of_MyStruct_or_Array_of_String" - e.g. schema name for `Result<MyStruct, Vec<String>>` has changed from "Result_Of_MyStruct_Or_Array_Of_String" to "Result_of_MyStruct_or_Array_of_String"
- Some provided `JsonSchema` implementations with the same `type` but different `format`s (e.g. `i8` and `usize`) used the `type` as their name. They have now been updated to use `format` as their name. - Some provided `JsonSchema` implementations with the same `type` but different `format`s (e.g. `i8` and `usize`) used the `type` as their name. They have now been updated to use `format` as their name.
- Previously, schema generation would incorrectly assume types such as `MyStruct<i8>` and `MyStruct<usize>` were identical, and give them a single schema definition called `MyStruct_for_Integer` despite the fact they should have different schemas. Now they will each have their own schema (`MyStruct_for_i8` and `MyStruct_for_usize` respectively). - Previously, schema generation would incorrectly assume types such as `MyStruct<i8>` and `MyStruct<usize>` were identical, and give them a single schema definition called `MyStruct_for_Integer` despite the fact they should have different schemas. Now they will each have their own schema (`MyStruct_for_i8` and `MyStruct_for_usize` respectively).

View file

@ -0,0 +1,5 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "schema_fn",
"type": "boolean"
}

View file

@ -42,3 +42,12 @@ pub struct Newtype(#[schemars(schema_with = "schema_fn")] DoesntImplementJsonSch
fn struct_newtype() -> TestResult { fn struct_newtype() -> TestResult {
test_default_generated_schema::<Newtype>("schema_with-newtype") test_default_generated_schema::<Newtype>("schema_with-newtype")
} }
#[derive(Debug, JsonSchema)]
#[schemars(transparent)]
pub struct TransparentNewtype(#[schemars(schema_with = "schema_fn")] DoesntImplementJsonSchema);
#[test]
fn struct_transparent_newtype() -> TestResult {
test_default_generated_schema::<TransparentNewtype>("schema_with-transparent-newtype")
}

View file

@ -38,35 +38,37 @@ fn derive_json_schema(mut input: syn::DeriveInput) -> TokenStream {
if let Some(transparent_field) = cont.transparent_field() { if let Some(transparent_field) = cont.transparent_field() {
let (ty, type_def) = schema_exprs::type_for_schema(transparent_field, 0); let (ty, type_def) = schema_exprs::type_for_schema(transparent_field, 0);
return quote! { return quote! {
#[automatically_derived] const _: () = {
impl #impl_generics schemars::JsonSchema for #type_name #ty_generics #where_clause {
#type_def #type_def
fn is_referenceable() -> bool { #[automatically_derived]
<#ty as schemars::JsonSchema>::is_referenceable() impl #impl_generics schemars::JsonSchema for #type_name #ty_generics #where_clause {
} fn is_referenceable() -> bool {
<#ty as schemars::JsonSchema>::is_referenceable()
}
fn schema_name() -> std::string::String { fn schema_name() -> std::string::String {
<#ty as schemars::JsonSchema>::schema_name() <#ty as schemars::JsonSchema>::schema_name()
} }
fn json_schema(gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema { fn json_schema(gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema {
<#ty as schemars::JsonSchema>::json_schema(gen) <#ty as schemars::JsonSchema>::json_schema(gen)
} }
fn json_schema_for_flatten(gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema { fn json_schema_for_flatten(gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema {
<#ty as schemars::JsonSchema>::json_schema_for_flatten(gen) <#ty as schemars::JsonSchema>::json_schema_for_flatten(gen)
} }
fn add_schema_as_property( fn add_schema_as_property(
gen: &mut schemars::gen::SchemaGenerator, gen: &mut schemars::gen::SchemaGenerator,
parent: &mut schemars::schema::SchemaObject, parent: &mut schemars::schema::SchemaObject,
name: String, name: String,
metadata: Option<schemars::schema::Metadata>, metadata: Option<schemars::schema::Metadata>,
required: bool, required: bool,
) { ) {
<#ty as schemars::JsonSchema>::add_schema_as_property(gen, parent, name, metadata, required) <#ty as schemars::JsonSchema>::add_schema_as_property(gen, parent, name, metadata, required)
} }
};
}; };
}; };
} }