unistructgen-openapi-parser 0.1.1

OpenAPI/Swagger parser for UniStructGen - generates Rust types from OpenAPI specifications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

//! Error types for OpenAPI parser

use thiserror::Error;

/// Result type for OpenAPI parser operations
pub type Result<T> = std::result::Result<T, OpenApiError>;

/// Errors that can occur during OpenAPI parsing
#[derive(Error, Debug)]
pub enum OpenApiError {
    /// Failed to parse YAML
    #[error("Failed to parse YAML: {0}")]
    YamlParse(#[from] serde_yaml::Error),

    /// Failed to parse JSON
    #[error("Failed to parse JSON: {0}")]
    JsonParse(#[from] serde_json::Error),

    /// Invalid OpenAPI specification
    #[error("Invalid OpenAPI specification: {0}")]
    InvalidSpec(String),

    /// Missing required field
    #[error("Missing required field: {0}")]
    MissingField(String),

    /// Unsupported schema type
    #[error("Unsupported schema type: {0}")]
    UnsupportedType(String),

    /// Reference resolution failed
    #[error("Failed to resolve reference '{reference}': {reason}")]
    ReferenceResolution {
        /// The reference that couldn't be resolved
        reference: String,
        /// Why it failed
        reason: String,
    },

    /// Circular reference detected
    #[error("Circular reference detected: {0}")]
    CircularReference(String),

    /// Invalid schema composition
    #[error("Invalid schema composition (allOf/oneOf/anyOf): {0}")]
    InvalidComposition(String),

    /// HTTP fetch error
    #[cfg(feature = "fetch")]
    #[error("Failed to fetch OpenAPI spec from URL: {0}")]
    FetchError(String),

    /// IO error
    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),

    /// Generic error
    #[error("{0}")]
    Other(String),
}

impl OpenApiError {
    /// Create a new invalid spec error
    pub fn invalid_spec(msg: impl Into<String>) -> Self {
        Self::InvalidSpec(msg.into())
    }

    /// Create a new missing field error
    pub fn missing_field(field: impl Into<String>) -> Self {
        Self::MissingField(field.into())
    }

    /// Create a new unsupported type error
    pub fn unsupported_type(type_name: impl Into<String>) -> Self {
        Self::UnsupportedType(type_name.into())
    }

    /// Create a new reference resolution error
    pub fn reference_resolution(reference: impl Into<String>, reason: impl Into<String>) -> Self {
        Self::ReferenceResolution {
            reference: reference.into(),
            reason: reason.into(),
        }
    }

    /// Create a new circular reference error
    pub fn circular_reference(path: impl Into<String>) -> Self {
        Self::CircularReference(path.into())
    }

    /// Create a new invalid composition error
    pub fn invalid_composition(msg: impl Into<String>) -> Self {
        Self::InvalidComposition(msg.into())
    }
}