Update readme for v1
This commit is contained in:
Graham Esau
parent
3ee7c7f5e5
commit
97b70aa82c
2 changed files with 22 additions and 27 deletions
31
README.md
31
README.md
|
|
@ -251,33 +251,28 @@ println!("{}", serde_json::to_string_pretty(&schema).unwrap());
|
||||||
## Feature Flags
|
## Feature Flags
|
||||||
|
|
||||||
- `derive` (enabled by default) - provides `#[derive(JsonSchema)]` macro
|
- `derive` (enabled by default) - provides `#[derive(JsonSchema)]` macro
|
||||||
- `impl_json_schema` - implements `JsonSchema` for Schemars types themselves
|
- `preserve_order` - keep the order of struct fields in `Schema` properties
|
||||||
- `preserve_order` - keep the order of struct fields in `Schema` and `SchemaObject`
|
|
||||||
- `raw_value` - implements `JsonSchema` for `serde_json::value::RawValue` (enables the serde_json `raw_value` feature)
|
- `raw_value` - implements `JsonSchema` for `serde_json::value::RawValue` (enables the serde_json `raw_value` feature)
|
||||||
|
|
||||||
Schemars can implement `JsonSchema` on types from several popular crates, enabled via feature flags (dependency versions are shown in brackets):
|
Schemars can implement `JsonSchema` on types from several popular crates, enabled via feature flags (dependency versions are shown in brackets):
|
||||||
|
|
||||||
- `chrono` - [chrono](https://crates.io/crates/chrono) (^0.4)
|
|
||||||
- `indexmap1` - [indexmap](https://crates.io/crates/indexmap) (^1.2)
|
|
||||||
- `indexmap2` - [indexmap](https://crates.io/crates/indexmap) (^2.0)
|
|
||||||
- `either` - [either](https://crates.io/crates/either) (^1.3)
|
|
||||||
- `uuid08` - [uuid](https://crates.io/crates/uuid) (^0.8)
|
|
||||||
- `uuid1` - [uuid](https://crates.io/crates/uuid) (^1.0)
|
|
||||||
- `smallvec` - [smallvec](https://crates.io/crates/smallvec) (^1.0)
|
|
||||||
- `arrayvec05` - [arrayvec](https://crates.io/crates/arrayvec) (^0.5)
|
|
||||||
- `arrayvec07` - [arrayvec](https://crates.io/crates/arrayvec) (^0.7)
|
- `arrayvec07` - [arrayvec](https://crates.io/crates/arrayvec) (^0.7)
|
||||||
- `url` - [url](https://crates.io/crates/url) (^2.0)
|
|
||||||
- `bytes` - [bytes](https://crates.io/crates/bytes) (^1.0)
|
|
||||||
- `enumset` - [enumset](https://crates.io/crates/enumset) (^1.0)
|
|
||||||
- `rust_decimal` - [rust_decimal](https://crates.io/crates/rust_decimal) (^1.0)
|
|
||||||
- `bigdecimal03` - [bigdecimal](https://crates.io/crates/bigdecimal) (^0.3)
|
|
||||||
- `bigdecimal04` - [bigdecimal](https://crates.io/crates/bigdecimal) (^0.4)
|
- `bigdecimal04` - [bigdecimal](https://crates.io/crates/bigdecimal) (^0.4)
|
||||||
- `smol_str` - [smol_str](https://crates.io/crates/smol_str) (^0.1.17)
|
- `bytes1` - [bytes](https://crates.io/crates/bytes) (^1.0)
|
||||||
- `semver` - [semver](https://crates.io/crates/semver) (^1.0.9)
|
- `chrono04` - [chrono](https://crates.io/crates/chrono) (^0.4)
|
||||||
|
- `either1` - [either](https://crates.io/crates/either) (^1.3)
|
||||||
|
- `enumset1` - [enumset](https://crates.io/crates/enumset) (^1.0)
|
||||||
|
- `indexmap2` - [indexmap](https://crates.io/crates/indexmap) (^2.0)
|
||||||
|
- `rust_decimal1` - [rust_decimal](https://crates.io/crates/rust_decimal) (^1.0)
|
||||||
|
- `semver1` - [semver](https://crates.io/crates/semver) (^1.0.9)
|
||||||
|
- `smallvec1` - [smallvec](https://crates.io/crates/smallvec) (^1.0)
|
||||||
|
- `smol_str02` - [smol_str](https://crates.io/crates/smol_str) (^0.2.1)
|
||||||
|
- `url2` - [url](https://crates.io/crates/url) (^2.0)
|
||||||
|
- `uuid1` - [uuid](https://crates.io/crates/uuid) (^1.0)
|
||||||
|
|
||||||
For example, to implement `JsonSchema` on types from `chrono`, enable it as a feature in the `schemars` dependency in your `Cargo.toml` like so:
|
For example, to implement `JsonSchema` on types from `chrono`, enable it as a feature in the `schemars` dependency in your `Cargo.toml` like so:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[dependencies]
|
[dependencies]
|
||||||
schemars = { version = "0.8", features = ["chrono"] }
|
schemars = { version = "1.0.0-alpha.1", features = ["chrono04"] }
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -21,19 +21,19 @@ dyn-clone = "1.0"
|
||||||
ref-cast = "1.0.22"
|
ref-cast = "1.0.22"
|
||||||
|
|
||||||
# optional dependencies
|
# optional dependencies
|
||||||
chrono04 = { version = "0.4", default-features = false, optional = true, package = "chrono" }
|
|
||||||
indexmap2 = { version = "2.0", default-features = false, optional = true, package = "indexmap" }
|
|
||||||
either1 = { version = "1.3", default-features = false, optional = true, package = "either" }
|
|
||||||
uuid1 = { version = "1.0", default-features = false, optional = true, package = "uuid" }
|
|
||||||
smallvec1 = { version = "1.0", default-features = false, optional = true, package = "smallvec" }
|
|
||||||
arrayvec07 = { version = "0.7", default-features = false, optional = true, package = "arrayvec" }
|
arrayvec07 = { version = "0.7", default-features = false, optional = true, package = "arrayvec" }
|
||||||
url2 = { version = "2.0", default-features = false, optional = true, package = "url" }
|
|
||||||
bytes1 = { version = "1.0", default-features = false, optional = true, package = "bytes" }
|
|
||||||
rust_decimal1 = { version = "1", default-features = false, optional = true, package = "rust_decimal"}
|
|
||||||
bigdecimal04 = { version = "0.4", default-features = false, optional = true, package = "bigdecimal" }
|
bigdecimal04 = { version = "0.4", default-features = false, optional = true, package = "bigdecimal" }
|
||||||
|
bytes1 = { version = "1.0", default-features = false, optional = true, package = "bytes" }
|
||||||
|
chrono04 = { version = "0.4", default-features = false, optional = true, package = "chrono" }
|
||||||
|
either1 = { version = "1.3", default-features = false, optional = true, package = "either" }
|
||||||
enumset1 = { version = "1.0", default-features = false, optional = true, package = "enumset" }
|
enumset1 = { version = "1.0", default-features = false, optional = true, package = "enumset" }
|
||||||
smol_str02 = { version = "0.2.1", default-features = false, optional = true, package = "smol_str" }
|
indexmap2 = { version = "2.0", default-features = false, optional = true, package = "indexmap" }
|
||||||
|
rust_decimal1 = { version = "1", default-features = false, optional = true, package = "rust_decimal"}
|
||||||
semver1 = { version = "1.0.9", default-features = false, optional = true, package = "semver" }
|
semver1 = { version = "1.0.9", default-features = false, optional = true, package = "semver" }
|
||||||
|
smallvec1 = { version = "1.0", default-features = false, optional = true, package = "smallvec" }
|
||||||
|
smol_str02 = { version = "0.2.1", default-features = false, optional = true, package = "smol_str" }
|
||||||
|
url2 = { version = "2.0", default-features = false, optional = true, package = "url" }
|
||||||
|
uuid1 = { version = "1.0", default-features = false, optional = true, package = "uuid" }
|
||||||
|
|
||||||
[dev-dependencies]
|
[dev-dependencies]
|
||||||
pretty_assertions = "1.2.1"
|
pretty_assertions = "1.2.1"
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue