Skip to content

Commit 34bfd95

Browse files
committed
docs: document schema fields
1 parent 4960f8b commit 34bfd95

File tree

5 files changed

+367
-62
lines changed

5 files changed

+367
-62
lines changed

.vscode/settings.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
"strs",
2525
"struct",
2626
"structs",
27+
"subschema",
28+
"subschemas",
2729
"valtree",
2830
"valtrees"
2931
],

Cargo.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ rust_2018_idioms = "deny"
1313
nonstandard_style = "deny"
1414
future_incompatible = "deny"
1515
missing_debug_implementations = { level = "warn", priority = -1 }
16-
missing_docs = { level = "warn", priority = -1 }
1716

1817
[workspace.dependencies]
1918
assert_matches = "1"

crates/oas3/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,12 @@
22

33
## Unreleased
44

5+
- Add `spec::ObjectSchema::deprecated` field.
6+
- Add `spec::ObjectSchema::examples` field.
57
- Add `spec::Contact::validate_email()` method.
68
- Expose the `spec::ClientCredentialsFlow::token_url` field.
9+
- The type of the `spec::ObjectSchema::enum` field is now `Vec<serde_json::Value>`.
10+
- The type of the `spec::ObjectSchema::const` field is now `Option<serde_json::Value>`.
711
- Rename `Error::{SemVerError => Semver}` enum variant.
812
- Rename `spec::RefError::{InvalidType => UnknownType}` enum variant.
913

crates/oas3/src/lib.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
//!
1515
//! [OpenAPI v3.1]: https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md
1616
17+
#![warn(missing_docs)]
1718
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
1819

1920
use std::{fs::File, io::Read, path::Path};

0 commit comments

Comments
 (0)