openapi-nexus 0.2.3

OpenAPI 3.x multi-language code generator
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
96
97
98
99
100
101
102

//! Top-level IR spec types.

use indexmap::IndexMap;
use serde::Serialize;

use super::operation::{IrOperation, IrSecurityRequirement};
use super::schema::IrSchema;

/// The top-level intermediate representation of an OpenAPI specification.
/// Version-agnostic — OAS 3.0, 3.1, and 3.2 all lower into this same type.
#[derive(Debug, Clone, Serialize)]
pub struct IrSpec {
    pub info: IrInfo,
    pub servers: Vec<IrServer>,
    pub schemas: IndexMap<String, IrSchema>,
    pub operations: Vec<IrOperation>,
    pub security_schemes: IndexMap<String, IrSecurityScheme>,
    pub security: Vec<IrSecurityRequirement>,
}

/// API metadata.
#[derive(Debug, Clone, Serialize)]
pub struct IrInfo {
    pub title: String,
    pub description: Option<String>,
    pub version: String,
    pub terms_of_service: Option<String>,
    pub contact: Option<IrContact>,
    pub license: Option<IrLicense>,
}

/// Contact information.
#[derive(Debug, Clone, Serialize)]
pub struct IrContact {
    pub name: Option<String>,
    pub url: Option<String>,
    pub email: Option<String>,
}

/// License information.
#[derive(Debug, Clone, Serialize)]
pub struct IrLicense {
    pub name: String,
    pub url: Option<String>,
    pub identifier: Option<String>,
}

/// Server definition.
#[derive(Debug, Clone, Serialize)]
pub struct IrServer {
    pub url: String,
    pub description: Option<String>,
}

/// Security scheme definition.
#[derive(Debug, Clone, Serialize)]
pub enum IrSecurityScheme {
    ApiKey {
        name: String,
        location: ApiKeyLocation,
        description: Option<String>,
    },
    Http {
        scheme: String,
        bearer_format: Option<String>,
        description: Option<String>,
    },
    OAuth2 {
        flows: Box<IrOAuth2Flows>,
        description: Option<String>,
    },
    OpenIdConnect {
        open_id_connect_url: String,
        description: Option<String>,
    },
    MutualTls {
        description: Option<String>,
    },
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub enum ApiKeyLocation {
    Query,
    Header,
    Cookie,
}

#[derive(Debug, Clone, Default, Serialize)]
pub struct IrOAuth2Flows {
    pub implicit: Option<IrOAuth2Flow>,
    pub password: Option<IrOAuth2Flow>,
    pub client_credentials: Option<IrOAuth2Flow>,
    pub authorization_code: Option<IrOAuth2Flow>,
}

#[derive(Debug, Clone, Serialize)]
pub struct IrOAuth2Flow {
    pub authorization_url: Option<String>,
    pub token_url: Option<String>,
    pub refresh_url: Option<String>,
    pub scopes: IndexMap<String, String>,
}