Skip to content

Commit 90da962

Browse files
committed
docs: document errors
1 parent 0f0e4c8 commit 90da962

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

crates/oas3/CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## Unreleased
44

55
- Expose the `spec::ClientCredentialsFlow::token_url` field.
6+
- Rename `Error::{SemVerError => Semver}` variant.
67

78
## 0.12.1
89

crates/oas3/src/error.rs

+4
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,19 @@ use crate::spec::Error as SpecError;
99
/// Top-level errors.
1010
#[derive(Debug, Display, Error, From)]
1111
pub enum Error {
12+
/// I/O error.
1213
#[display("I/O error")]
1314
Io(io::Error),
1415

16+
/// YAML error.
1517
#[display("YAML error")]
1618
Yaml(serde_yml::Error),
1719

20+
/// JSON error.
1821
#[display("JSON error")]
1922
Serialize(serde_json::Error),
2023

24+
/// Spec error.
2125
#[display("Spec error")]
2226
Spec(SpecError),
2327
}

crates/oas3/src/spec/error.rs

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
use derive_more::derive::{Display, Error, From};
2-
use semver::{Error as SemVerError, Version};
2+
use semver::{Error as SemverError, Version};
33

44
use crate::spec::{r#ref::RefError, schema::Error as SchemaError};
55

6-
/// Spec Errors
6+
/// Spec errors.
77
#[derive(Debug, Display, Error, From)]
88
pub enum Error {
9+
/// Reference error.
910
#[display("Reference error")]
1011
Ref(RefError),
1112

13+
/// Schema error.
1214
#[display("Schema error")]
1315
Schema(SchemaError),
1416

17+
/// Semver error.
1518
#[display("Semver error")]
16-
SemVerError(SemVerError),
19+
Semver(SemverError),
1720

21+
/// Unsupported spec file version.
1822
#[display("Unsupported spec file version ({})", _0)]
1923
UnsupportedSpecFileVersion(#[error(not(source))] Version),
2024
}

0 commit comments

Comments
 (0)