Merge pull request #1475 from CosmWasm/schema_for-future-proofing

Lock JSON schema version

Author: webmaster128

CHANGELOG.md

@@ -23,6 +23,8 @@ and this project adheres to
   `-Zminimal-versions` ([#1465]).
 - cosmwasm-profiler: Package was removed 🪦. It served its job showing us that we
   cannot properly measure different runtimes for differet Wasm opcodes.
+- cosmwasm-schema: schema generation is now locked to produce strictly
+  `draft-07` schemas
 
 [#1465]: https://github.com/CosmWasm/cosmwasm/pull/1465
 

packages/schema/src/lib.rs

@@ -3,6 +3,7 @@ mod export;
 mod idl;
 mod query_response;
 mod remove;
+mod schema_for;
 
 pub use export::{export_schema, export_schema_with_title};
 pub use idl::{Api, IDL_VERSION};
@@ -91,7 +92,6 @@ pub use cosmwasm_schema_derive::generate_api;
 /// };
 /// ```
 pub use cosmwasm_schema_derive::write_api;
-pub use schemars::schema_for;
 
 // For use in macro expansions
 pub use schemars;

packages/schema/src/schema_for.rs

@@ -0,0 +1,27 @@
+/// Generates a [`RootSchema`](crate::schemars::schema::RootSchema) for the given type using default settings.
+///
+/// The type must implement [`JsonSchema`](crate::schemars::JsonSchema).
+///
+/// The schema version is strictly `draft-07`.
+///
+/// # Example
+/// ```
+/// use cosmwasm_schema::schema_for;
+/// use schemars::JsonSchema;
+///
+/// #[derive(JsonSchema)]
+/// struct MyStruct {
+///     foo: i32,
+/// }
+///
+/// let my_schema = schema_for!(MyStruct);
+/// ```
+#[macro_export]
+macro_rules! schema_for {
+    ($type:ty) => {
+        $crate::schemars::gen::SchemaGenerator::new($crate::schemars::gen::SchemaSettings::draft07()).into_root_schema_for::<$type>()
+    };
+    ($_:expr) => {
+        compile_error!("The argument to `schema_for!` is not a type.")
+    };
+}