hen 0.20.1

Run protocol-aware API request collections from the command line or through MCP.
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

use std::path::PathBuf;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ContractSourceSpan {
    pub path: Option<PathBuf>,
    pub line: usize,
    pub column: usize,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ContractParameterShape {
    Scalar,
    Array,
    Object,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ContractParameter {
    pub name: String,
    pub location: String,
    pub required: bool,
    pub style: String,
    pub explode: bool,
    pub allow_reserved: bool,
    pub shape: ContractParameterShape,
    pub value: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ContractTypeRef {
    pub target: String,
    pub array_depth: usize,
    pub nullable: bool,
}

impl ContractTypeRef {
    pub fn new(target: impl Into<String>) -> Self {
        Self {
            target: target.into(),
            array_depth: 0,
            nullable: false,
        }
    }

    pub fn array(mut self) -> Self {
        self.array_depth += 1;
        self
    }

    pub fn nullable(mut self) -> Self {
        self.nullable = true;
        self
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ContractScalarDefinition {
    pub name: String,
    pub expression: String,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ContractSchemaField {
    pub name: String,
    pub value_type: ContractTypeRef,
    pub required: bool,
}

impl ContractSchemaField {
    pub fn required(name: impl Into<String>, value_type: ContractTypeRef) -> Self {
        Self {
            name: name.into(),
            value_type,
            required: true,
        }
    }

    pub fn optional(name: impl Into<String>, value_type: ContractTypeRef) -> Self {
        Self {
            name: name.into(),
            value_type,
            required: false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ContractDiscriminatorBranch {
    pub tag: String,
    pub target: String,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ContractSchemaShape {
    Object { fields: Vec<ContractSchemaField> },
    Array(ContractTypeRef),
    Alias(ContractTypeRef),
    AllOf(Vec<String>),
    OneOf(Vec<String>),
    AnyOf(Vec<String>),
    Not(String),
    Discriminator {
        field: String,
        branches: Vec<ContractDiscriminatorBranch>,
    },
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ContractSchemaDefinition {
    pub name: String,
    pub shape: ContractSchemaShape,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ContractRequestBody {
    pub content_type: String,
    pub example: Option<String>,
    pub schema: Option<ContractResponseSchema>,
    pub required: bool,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ContractResponseSchema {
    Scalar(String),
    Type(ContractTypeRef),
    Object { fields: Vec<ContractSchemaField> },
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ContractResponseBody {
    pub content_type: String,
    pub schema: Option<ContractResponseSchema>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ContractSecuritySchemeKind {
    ApiKeyHeader { name: String },
    ApiKeyQuery { name: String },
    ApiKeyCookie { name: String },
    HttpBasic,
    HttpBearer,
    OAuthClientCredentials { token_url: String, scopes: Vec<String> },
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ContractSecurityRequirement {
    pub scheme_name: String,
    pub kind: ContractSecuritySchemeKind,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ContractOperation {
    pub operation_id: Option<String>,
    pub summary: Option<String>,
    pub method: String,
    pub path: String,
    pub servers: Vec<String>,
    pub tags: Vec<String>,
    pub parameters: Vec<ContractParameter>,
    pub request_body: Option<ContractRequestBody>,
    pub response_body: Option<ContractResponseBody>,
    pub security: Vec<Vec<ContractSecurityRequirement>>,
    pub source_span: Option<ContractSourceSpan>,
}

#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub struct ContractDocument {
    pub servers: Vec<String>,
    pub scalars: Vec<ContractScalarDefinition>,
    pub schemas: Vec<ContractSchemaDefinition>,
    pub operations: Vec<ContractOperation>,
}