fork of hey-api/openapi-ts because I need some additional things
refactor: simplify NestJS plugin documentation and configuration.
+214
-5819
+4
-53
docs/openapi-ts/plugins/nest.md
+4
-53
docs/openapi-ts/plugins/nest.md
···
25
25
26
26
## Features
27
27
28
-
- NestJS v10 support
28
+
- NestJS support
29
29
- seamless integration with `@hey-api/openapi-ts` ecosystem
30
30
- type-safe controller methods via `implements`
31
31
- tag-based grouping for per-controller types
···
48
48
};
49
49
```
50
50
51
-
## Configuration
52
-
53
-
| Option | Type | Default | Description |
54
-
| ------------ | --------- | ------- | ------------------------------------------------------ |
55
-
| `groupByTag` | `boolean` | `false` | Group methods by OpenAPI tag into per-controller types |
56
-
57
51
## Output
58
52
59
-
The NestJS plugin will generate the following artifacts, depending on the input specification.
60
-
61
-
## Controller Methods
62
-
63
-
By default, a single `ControllerMethods` type is generated from all endpoints.
64
-
65
-
::: code-group
66
-
67
-
```ts [output]
68
-
import type {
69
-
ListPetsData,
70
-
ListPetsResponse,
71
-
ShowPetByIdData,
72
-
ShowPetByIdResponse,
73
-
} from './types.gen';
74
-
75
-
export type ControllerMethods = {
76
-
createPet: (body: CreatePetData['body']) => Promise<CreatePetResponse>;
77
-
listPets: (query?: ListPetsData['query']) => Promise<ListPetsResponse>;
78
-
showPetById: (path: ShowPetByIdData['path']) => Promise<ShowPetByIdResponse>;
79
-
};
80
-
```
81
-
82
-
```js [config]
83
-
export default {
84
-
input: 'hey-api/backend', // sign up at app.heyapi.dev
85
-
output: 'src/client',
86
-
plugins: [
87
-
// ...other plugins
88
-
{
89
-
name: 'nestjs',
90
-
},
91
-
],
92
-
};
93
-
```
94
-
95
-
:::
96
-
97
-
## Tag Grouping
98
-
99
-
When `groupByTag` is `true`, operations are grouped by their first OpenAPI tag into per-controller types. This is ideal for larger APIs with multiple controllers.
53
+
The NestJS plugin generates per-tag controller method types from your OpenAPI spec. Operations are grouped by their first OpenAPI tag into separate types like `PetsControllerMethods`, `StoreControllerMethods`, etc.
100
54
101
55
::: code-group
102
56
···
118
72
output: 'src/client',
119
73
plugins: [
120
74
// ...other plugins
121
-
{
122
-
groupByTag: true,
123
-
name: 'nestjs',
124
-
},
75
+
'nestjs',
125
76
],
126
77
};
127
78
```
···
193
144
194
145
Methods using `@Res()` for raw response access are incompatible with `implements` because the extra parameter breaks assignability.
195
146
196
-
Operations without tags are grouped under `DefaultControllerMethods` when `groupByTag` is `true`.
147
+
Operations without tags are grouped under `DefaultControllerMethods`.
197
148
198
149
## API
199
150
+1
-1
eslint.config.js
+1
-1
eslint.config.js
+1
-7
examples/openapi-ts-nestjs/openapi-ts.config.ts
+1
-7
examples/openapi-ts-nestjs/openapi-ts.config.ts
+46
-4
packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/nestjs/default/nestjs.gen.ts
+46
-4
packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/nestjs/default/nestjs.gen.ts
···
2
2
3
3
import type { CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesResponse, CallWithParametersData, CallWithResponseAndNoContentResponseResponse, CallWithResponseResponse, CallWithResponsesResponse, CallWithWeirdParameterNamesData, CollectionFormatData, ComplexTypesData, ComplexTypesResponse, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, PostApiVbyApiVersionBodyData, PostApiVbyApiVersionBodyResponse, TestErrorCodeData, TypesData, TypesResponse } from './types.gen';
4
4
5
-
export type ControllerMethods = {
5
+
export type DefaultControllerMethods = {
6
6
serviceWithEmptyTag: () => Promise<void>;
7
7
patchApiVbyApiVersionNoTag: () => Promise<void>;
8
8
fooWow: () => Promise<void>;
9
+
postApiVbyApiVersionBody: (body: PostApiVbyApiVersionBodyData['body']) => Promise<PostApiVbyApiVersionBodyResponse>;
10
+
};
11
+
12
+
export type SimpleControllerMethods = {
9
13
deleteCallWithoutParametersAndResponse: () => Promise<void>;
10
14
getCallWithoutParametersAndResponse: () => Promise<void>;
11
15
headCallWithoutParametersAndResponse: () => Promise<void>;
···
13
17
patchCallWithoutParametersAndResponse: () => Promise<void>;
14
18
postCallWithoutParametersAndResponse: () => Promise<void>;
15
19
putCallWithoutParametersAndResponse: () => Promise<void>;
20
+
};
21
+
22
+
export type DescriptionsControllerMethods = {
16
23
callWithDescriptions: (query?: CallWithDescriptionsData['query']) => Promise<void>;
24
+
};
25
+
26
+
export type ParametersControllerMethods = {
17
27
callWithParameters: (path: CallWithParametersData['path'], query: CallWithParametersData['query'], headers: CallWithParametersData['headers']) => Promise<void>;
18
28
callWithWeirdParameterNames: (path: CallWithWeirdParameterNamesData['path'], query: CallWithWeirdParameterNamesData['query'], body: CallWithWeirdParameterNamesData['body'], headers: CallWithWeirdParameterNamesData['headers']) => Promise<void>;
29
+
};
30
+
31
+
export type DefaultsControllerMethods = {
19
32
callWithDefaultParameters: (query: CallWithDefaultParametersData['query']) => Promise<void>;
20
33
callWithDefaultOptionalParameters: (query?: CallWithDefaultOptionalParametersData['query']) => Promise<void>;
21
34
callToTestOrderOfParams: (query: CallToTestOrderOfParamsData['query']) => Promise<void>;
35
+
};
36
+
37
+
export type DuplicateControllerMethods = {
22
38
duplicateName: () => Promise<void>;
23
39
duplicateName2: () => Promise<void>;
24
40
duplicateName3: () => Promise<void>;
25
41
duplicateName4: () => Promise<void>;
42
+
};
43
+
44
+
export type NoContentControllerMethods = {
26
45
callWithNoContentResponse: () => Promise<void>;
46
+
};
47
+
48
+
export type ResponseControllerMethods = {
27
49
callWithResponseAndNoContentResponse: () => Promise<CallWithResponseAndNoContentResponseResponse>;
28
-
dummyA: () => Promise<void>;
29
-
dummyB: () => Promise<void>;
30
50
callWithResponse: () => Promise<CallWithResponseResponse>;
31
51
callWithDuplicateResponses: () => Promise<CallWithDuplicateResponsesResponse>;
32
52
callWithResponses: () => Promise<CallWithResponsesResponse>;
53
+
};
54
+
55
+
export type MultipleTags1ControllerMethods = {
56
+
dummyA: () => Promise<void>;
57
+
dummyB: () => Promise<void>;
58
+
};
59
+
60
+
export type CollectionFormatControllerMethods = {
33
61
collectionFormat: (query: CollectionFormatData['query']) => Promise<void>;
62
+
};
63
+
64
+
export type TypesControllerMethods = {
34
65
types: (query: TypesData['query'], path?: TypesData['path']) => Promise<TypesResponse>;
66
+
};
67
+
68
+
export type ComplexControllerMethods = {
35
69
complexTypes: (query: ComplexTypesData['query']) => Promise<ComplexTypesResponse>;
70
+
};
71
+
72
+
export type HeaderControllerMethods = {
36
73
callWithResultFromHeader: () => Promise<void>;
74
+
};
75
+
76
+
export type ErrorControllerMethods = {
37
77
testErrorCode: (query: TestErrorCodeData['query']) => Promise<void>;
78
+
};
79
+
80
+
export type NonAsciiÆøåÆøÅöôêÊControllerMethods = {
38
81
nonAsciiæøåÆøÅöôêÊ字符串: (query: NonAsciiæøåÆøÅöôêÊ字符串Data['query']) => Promise<NonAsciiæøåÆøÅöôêÊ字符串Response>;
39
-
postApiVbyApiVersionBody: (body: PostApiVbyApiVersionBodyData['body']) => Promise<PostApiVbyApiVersionBodyResponse>;
40
82
};
-3
packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/nestjs/group-by-tag/index.ts
-3
packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/nestjs/group-by-tag/index.ts
···
1
-
// This file is auto-generated by @hey-api/openapi-ts
2
-
3
-
export type { ArrayWithArray, ArrayWithBooleans, ArrayWithNumbers, ArrayWithProperties, ArrayWithReferences, ArrayWithStrings, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesError, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponse, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponse, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesError, CallWithResponsesErrors, CallWithResponsesResponse, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, ClientOptions, CollectionFormatData, CommentWithBackticks, CommentWithBackticksAndQuotes, CommentWithBreaks, CommentWithExpressionPlaceholders, CommentWithQuotes, CommentWithReservedCharacters, CommentWithSlashes, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponse, ComplexTypesResponses, Date, Default, DeleteCallWithoutParametersAndResponseData, DictionaryWithArray, DictionaryWithDictionary, DictionaryWithProperties, DictionaryWithReference, DictionaryWithString, DummyAData, DummyAResponses, DummyBData, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, EnumFromDescription, EnumWithExtensions, EnumWithNumbers, EnumWithStrings, ExternalRefA, ExternalRefB, ExternalSharedExternalSharedModel, FailureFailure, FooWowData, FooWowResponses, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, ModelThatExtends, ModelThatExtendsExtends, ModelWithArray, ModelWithBoolean, ModelWithCircularReference, ModelWithDictionary, ModelWithDuplicateImports, ModelWithDuplicateProperties, ModelWithEnum, ModelWithEnumFromDescription, ModelWithInteger, ModelWithNestedEnums, ModelWithNestedProperties, ModelWithNullableString, ModelWithOrderedProperties, ModelWithPattern, ModelWithPatternWritable, ModelWithProperties, ModelWithPropertiesWritable, ModelWithReference, ModelWithReferenceWritable, ModelWithString, ModelWithStringError, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, NonAsciiæøåÆøÅöôêÊ字符串Responses, NonAsciiStringæøåÆøÅöôêÊ字符串, OptionsCallWithoutParametersAndResponseData, ParameterActivityParams, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionBodyData, PostApiVbyApiVersionBodyError, PostApiVbyApiVersionBodyErrors, PostApiVbyApiVersionBodyResponse, PostApiVbyApiVersionBodyResponses, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, ResponsePostActivityResponse, ServiceWithEmptyTagData, SimpleBoolean, SimpleFile, SimpleInteger, SimpleReference, SimpleString, SimpleStringWithPattern, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponse, TypesResponses } from './types.gen';
-82
packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/nestjs/group-by-tag/nestjs.gen.ts
-82
packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/nestjs/group-by-tag/nestjs.gen.ts
···
1
-
// This file is auto-generated by @hey-api/openapi-ts
2
-
3
-
import type { CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesResponse, CallWithParametersData, CallWithResponseAndNoContentResponseResponse, CallWithResponseResponse, CallWithResponsesResponse, CallWithWeirdParameterNamesData, CollectionFormatData, ComplexTypesData, ComplexTypesResponse, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, PostApiVbyApiVersionBodyData, PostApiVbyApiVersionBodyResponse, TestErrorCodeData, TypesData, TypesResponse } from './types.gen';
4
-
5
-
export type DefaultControllerMethods = {
6
-
serviceWithEmptyTag: () => Promise<void>;
7
-
patchApiVbyApiVersionNoTag: () => Promise<void>;
8
-
fooWow: () => Promise<void>;
9
-
postApiVbyApiVersionBody: (body: PostApiVbyApiVersionBodyData['body']) => Promise<PostApiVbyApiVersionBodyResponse>;
10
-
};
11
-
12
-
export type SimpleControllerMethods = {
13
-
deleteCallWithoutParametersAndResponse: () => Promise<void>;
14
-
getCallWithoutParametersAndResponse: () => Promise<void>;
15
-
headCallWithoutParametersAndResponse: () => Promise<void>;
16
-
optionsCallWithoutParametersAndResponse: () => Promise<void>;
17
-
patchCallWithoutParametersAndResponse: () => Promise<void>;
18
-
postCallWithoutParametersAndResponse: () => Promise<void>;
19
-
putCallWithoutParametersAndResponse: () => Promise<void>;
20
-
};
21
-
22
-
export type DescriptionsControllerMethods = {
23
-
callWithDescriptions: (query?: CallWithDescriptionsData['query']) => Promise<void>;
24
-
};
25
-
26
-
export type ParametersControllerMethods = {
27
-
callWithParameters: (path: CallWithParametersData['path'], query: CallWithParametersData['query'], headers: CallWithParametersData['headers']) => Promise<void>;
28
-
callWithWeirdParameterNames: (path: CallWithWeirdParameterNamesData['path'], query: CallWithWeirdParameterNamesData['query'], body: CallWithWeirdParameterNamesData['body'], headers: CallWithWeirdParameterNamesData['headers']) => Promise<void>;
29
-
};
30
-
31
-
export type DefaultsControllerMethods = {
32
-
callWithDefaultParameters: (query: CallWithDefaultParametersData['query']) => Promise<void>;
33
-
callWithDefaultOptionalParameters: (query?: CallWithDefaultOptionalParametersData['query']) => Promise<void>;
34
-
callToTestOrderOfParams: (query: CallToTestOrderOfParamsData['query']) => Promise<void>;
35
-
};
36
-
37
-
export type DuplicateControllerMethods = {
38
-
duplicateName: () => Promise<void>;
39
-
duplicateName2: () => Promise<void>;
40
-
duplicateName3: () => Promise<void>;
41
-
duplicateName4: () => Promise<void>;
42
-
};
43
-
44
-
export type NoContentControllerMethods = {
45
-
callWithNoContentResponse: () => Promise<void>;
46
-
};
47
-
48
-
export type ResponseControllerMethods = {
49
-
callWithResponseAndNoContentResponse: () => Promise<CallWithResponseAndNoContentResponseResponse>;
50
-
callWithResponse: () => Promise<CallWithResponseResponse>;
51
-
callWithDuplicateResponses: () => Promise<CallWithDuplicateResponsesResponse>;
52
-
callWithResponses: () => Promise<CallWithResponsesResponse>;
53
-
};
54
-
55
-
export type MultipleTags1ControllerMethods = {
56
-
dummyA: () => Promise<void>;
57
-
dummyB: () => Promise<void>;
58
-
};
59
-
60
-
export type CollectionFormatControllerMethods = {
61
-
collectionFormat: (query: CollectionFormatData['query']) => Promise<void>;
62
-
};
63
-
64
-
export type TypesControllerMethods = {
65
-
types: (query: TypesData['query'], path?: TypesData['path']) => Promise<TypesResponse>;
66
-
};
67
-
68
-
export type ComplexControllerMethods = {
69
-
complexTypes: (query: ComplexTypesData['query']) => Promise<ComplexTypesResponse>;
70
-
};
71
-
72
-
export type HeaderControllerMethods = {
73
-
callWithResultFromHeader: () => Promise<void>;
74
-
};
75
-
76
-
export type ErrorControllerMethods = {
77
-
testErrorCode: (query: TestErrorCodeData['query']) => Promise<void>;
78
-
};
79
-
80
-
export type NonAsciiÆøåÆøÅöôêÊControllerMethods = {
81
-
nonAsciiæøåÆøÅöôêÊ字符串: (query: NonAsciiæøåÆøÅöôêÊ字符串Data['query']) => Promise<NonAsciiæøåÆøÅöôêÊ字符串Response>;
82
-
};
-1188
packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/nestjs/group-by-tag/types.gen.ts
-1188
packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/nestjs/group-by-tag/types.gen.ts
···
1
-
// This file is auto-generated by @hey-api/openapi-ts
2
-
3
-
export type ClientOptions = {
4
-
baseUrl: 'http://localhost:3000/base' | (string & {});
5
-
};
6
-
7
-
export type ExternalRefA = ExternalSharedExternalSharedModel;
8
-
9
-
export type ExternalRefB = ExternalSharedExternalSharedModel;
10
-
11
-
/**
12
-
* Testing multiline comments in string: First line
13
-
* Second line
14
-
*
15
-
* Fourth line
16
-
*/
17
-
export type CommentWithBreaks = number;
18
-
19
-
/**
20
-
* Testing backticks in string: `backticks` and ```multiple backticks``` should work
21
-
*/
22
-
export type CommentWithBackticks = number;
23
-
24
-
/**
25
-
* Testing backticks and quotes in string: `backticks`, 'quotes', "double quotes" and ```multiple backticks``` should work
26
-
*/
27
-
export type CommentWithBackticksAndQuotes = number;
28
-
29
-
/**
30
-
* Testing slashes in string: \backwards\\\ and /forwards/// should work
31
-
*/
32
-
export type CommentWithSlashes = number;
33
-
34
-
/**
35
-
* Testing expression placeholders in string: ${expression} should work
36
-
*/
37
-
export type CommentWithExpressionPlaceholders = number;
38
-
39
-
/**
40
-
* Testing quotes in string: 'single quote''' and "double quotes""" should work
41
-
*/
42
-
export type CommentWithQuotes = number;
43
-
44
-
/**
45
-
* Testing reserved characters in string: * inline * and ** inline ** should work
46
-
*/
47
-
export type CommentWithReservedCharacters = number;
48
-
49
-
/**
50
-
* This is a simple number
51
-
*/
52
-
export type SimpleInteger = number;
53
-
54
-
/**
55
-
* This is a simple boolean
56
-
*/
57
-
export type SimpleBoolean = boolean;
58
-
59
-
/**
60
-
* This is a simple string
61
-
*/
62
-
export type SimpleString = string;
63
-
64
-
/**
65
-
* A string with non-ascii (unicode) characters valid in typescript identifiers (æøåÆØÅöÔèÈ字符串)
66
-
*/
67
-
export type NonAsciiStringæøåÆøÅöôêÊ字符串 = string;
68
-
69
-
/**
70
-
* This is a simple file
71
-
*/
72
-
export type SimpleFile = Blob | File;
73
-
74
-
export type SimpleReference = ModelWithString;
75
-
76
-
/**
77
-
* This is a simple string
78
-
*/
79
-
export type SimpleStringWithPattern = string;
80
-
81
-
/**
82
-
* This is a simple enum with strings
83
-
*/
84
-
export type EnumWithStrings = 'Success' | 'Warning' | 'Error' | '\'Single Quote\'' | '"Double Quotes"' | 'Non-ascii: øæåôöØÆÅÔÖ字符串';
85
-
86
-
/**
87
-
* This is a simple enum with numbers
88
-
*/
89
-
export type EnumWithNumbers = 1 | 2 | 3 | 1.1 | 1.2 | 1.3 | 100 | 200 | 300 | -100 | -200 | -300 | -1.1 | -1.2 | -1.3;
90
-
91
-
/**
92
-
* Success=1,Warning=2,Error=3
93
-
*/
94
-
export type EnumFromDescription = number;
95
-
96
-
/**
97
-
* This is a simple enum with numbers
98
-
*/
99
-
export type EnumWithExtensions = 200 | 400 | 500;
100
-
101
-
/**
102
-
* This is a simple array with numbers
103
-
*/
104
-
export type ArrayWithNumbers = Array<number>;
105
-
106
-
/**
107
-
* This is a simple array with booleans
108
-
*/
109
-
export type ArrayWithBooleans = Array<boolean>;
110
-
111
-
/**
112
-
* This is a simple array with strings
113
-
*/
114
-
export type ArrayWithStrings = Array<string>;
115
-
116
-
/**
117
-
* This is a simple array with references
118
-
*/
119
-
export type ArrayWithReferences = Array<ModelWithString>;
120
-
121
-
/**
122
-
* This is a simple array containing an array
123
-
*/
124
-
export type ArrayWithArray = Array<Array<ModelWithString>>;
125
-
126
-
/**
127
-
* This is a simple array with properties
128
-
*/
129
-
export type ArrayWithProperties = Array<{
130
-
foo?: string;
131
-
bar?: string;
132
-
}>;
133
-
134
-
/**
135
-
* This is a string dictionary
136
-
*/
137
-
export type DictionaryWithString = {
138
-
[key: string]: string;
139
-
};
140
-
141
-
/**
142
-
* This is a string reference
143
-
*/
144
-
export type DictionaryWithReference = {
145
-
[key: string]: ModelWithString;
146
-
};
147
-
148
-
/**
149
-
* This is a complex dictionary
150
-
*/
151
-
export type DictionaryWithArray = {
152
-
[key: string]: Array<ModelWithString>;
153
-
};
154
-
155
-
/**
156
-
* This is a string dictionary
157
-
*/
158
-
export type DictionaryWithDictionary = {
159
-
[key: string]: {
160
-
[key: string]: string;
161
-
};
162
-
};
163
-
164
-
/**
165
-
* This is a complex dictionary
166
-
*/
167
-
export type DictionaryWithProperties = {
168
-
[key: string]: {
169
-
foo?: string;
170
-
bar?: string;
171
-
};
172
-
};
173
-
174
-
/**
175
-
* This is a type-only model that defines Date as a string
176
-
*/
177
-
export type Date = string;
178
-
179
-
/**
180
-
* This is a model with one number property
181
-
*/
182
-
export type ModelWithInteger = {
183
-
/**
184
-
* This is a simple number property
185
-
*/
186
-
prop?: number;
187
-
};
188
-
189
-
/**
190
-
* This is a model with one boolean property
191
-
*/
192
-
export type ModelWithBoolean = {
193
-
/**
194
-
* This is a simple boolean property
195
-
*/
196
-
prop?: boolean;
197
-
};
198
-
199
-
/**
200
-
* This is a model with one string property
201
-
*/
202
-
export type ModelWithString = {
203
-
/**
204
-
* This is a simple string property
205
-
*/
206
-
prop?: string;
207
-
};
208
-
209
-
/**
210
-
* This is a model with one string property
211
-
*/
212
-
export type ModelWithStringError = {
213
-
/**
214
-
* This is a simple string property
215
-
*/
216
-
prop?: string;
217
-
};
218
-
219
-
/**
220
-
* This is a model with one string property
221
-
*/
222
-
export type ModelWithNullableString = {
223
-
/**
224
-
* This is a simple string property
225
-
*/
226
-
nullableProp?: string | null;
227
-
/**
228
-
* This is a simple string property
229
-
*/
230
-
nullableRequiredProp: string | null;
231
-
};
232
-
233
-
/**
234
-
* This is a model with one enum
235
-
*/
236
-
export type ModelWithEnum = {
237
-
/**
238
-
* This is a simple enum with strings
239
-
*/
240
-
test?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串';
241
-
/**
242
-
* These are the HTTP error code enums
243
-
*/
244
-
statusCode?: '100' | '200 FOO' | '300 FOO_BAR' | '400 foo-bar' | '500 foo.bar' | '600 foo&bar';
245
-
/**
246
-
* Simple boolean enum
247
-
*/
248
-
bool?: true;
249
-
};
250
-
251
-
/**
252
-
* This is a model with one enum
253
-
*/
254
-
export type ModelWithEnumFromDescription = {
255
-
/**
256
-
* Success=1,Warning=2,Error=3
257
-
*/
258
-
test?: number;
259
-
};
260
-
261
-
/**
262
-
* This is a model with nested enums
263
-
*/
264
-
export type ModelWithNestedEnums = {
265
-
dictionaryWithEnum?: {
266
-
[key: string]: 'Success' | 'Warning' | 'Error';
267
-
};
268
-
dictionaryWithEnumFromDescription?: {
269
-
[key: string]: number;
270
-
};
271
-
arrayWithEnum?: Array<'Success' | 'Warning' | 'Error'>;
272
-
arrayWithDescription?: Array<number>;
273
-
};
274
-
275
-
/**
276
-
* This is a model with one property containing a reference
277
-
*/
278
-
export type ModelWithReference = {
279
-
prop?: ModelWithProperties;
280
-
};
281
-
282
-
/**
283
-
* This is a model with one property containing an array
284
-
*/
285
-
export type ModelWithArray = {
286
-
prop?: Array<ModelWithString>;
287
-
propWithFile?: Array<Blob | File>;
288
-
propWithNumber?: Array<number>;
289
-
};
290
-
291
-
/**
292
-
* This is a model with one property containing a dictionary
293
-
*/
294
-
export type ModelWithDictionary = {
295
-
prop?: {
296
-
[key: string]: string;
297
-
};
298
-
};
299
-
300
-
/**
301
-
* This is a model with one property containing a circular reference
302
-
*/
303
-
export type ModelWithCircularReference = {
304
-
prop?: ModelWithCircularReference;
305
-
};
306
-
307
-
/**
308
-
* This is a model with one nested property
309
-
*/
310
-
export type ModelWithProperties = {
311
-
required: string;
312
-
readonly requiredAndReadOnly: string;
313
-
string?: string;
314
-
number?: number;
315
-
boolean?: boolean;
316
-
reference?: ModelWithString;
317
-
'property with space'?: string;
318
-
default?: string;
319
-
try?: string;
320
-
readonly '@namespace.string'?: string;
321
-
readonly '@namespace.integer'?: number;
322
-
};
323
-
324
-
/**
325
-
* This is a model with one nested property
326
-
*/
327
-
export type ModelWithNestedProperties = {
328
-
readonly first: {
329
-
readonly second: {
330
-
readonly third: string;
331
-
};
332
-
};
333
-
};
334
-
335
-
/**
336
-
* This is a model with duplicated properties
337
-
*/
338
-
export type ModelWithDuplicateProperties = {
339
-
prop?: ModelWithString;
340
-
};
341
-
342
-
/**
343
-
* This is a model with ordered properties
344
-
*/
345
-
export type ModelWithOrderedProperties = {
346
-
zebra?: string;
347
-
apple?: string;
348
-
hawaii?: string;
349
-
};
350
-
351
-
/**
352
-
* This is a model with duplicated imports
353
-
*/
354
-
export type ModelWithDuplicateImports = {
355
-
propA?: ModelWithString;
356
-
propB?: ModelWithString;
357
-
propC?: ModelWithString;
358
-
};
359
-
360
-
/**
361
-
* This is a model that extends another model
362
-
*/
363
-
export type ModelThatExtends = ModelWithString & {
364
-
propExtendsA?: string;
365
-
propExtendsB?: ModelWithString;
366
-
};
367
-
368
-
/**
369
-
* This is a model that extends another model
370
-
*/
371
-
export type ModelThatExtendsExtends = ModelWithString & ModelThatExtends & {
372
-
propExtendsC?: string;
373
-
propExtendsD?: ModelWithString;
374
-
};
375
-
376
-
export type Default = {
377
-
name?: string;
378
-
};
379
-
380
-
/**
381
-
* This is a model that contains a some patterns
382
-
*/
383
-
export type ModelWithPattern = {
384
-
key: string;
385
-
name: string;
386
-
readonly enabled?: boolean;
387
-
readonly modified?: string;
388
-
id?: string;
389
-
text?: string;
390
-
patternWithSingleQuotes?: string;
391
-
patternWithNewline?: string;
392
-
patternWithBacktick?: string;
393
-
};
394
-
395
-
export type ParameterActivityParams = {
396
-
description?: string;
397
-
graduate_id?: number;
398
-
organization_id?: number;
399
-
parent_activity?: number;
400
-
post_id?: number;
401
-
};
402
-
403
-
export type ResponsePostActivityResponse = {
404
-
description?: string;
405
-
graduate_id?: number;
406
-
organization_id?: number;
407
-
parent_activity_id?: number;
408
-
post_id?: number;
409
-
};
410
-
411
-
export type FailureFailure = {
412
-
error?: string;
413
-
message?: string;
414
-
reference_code?: string;
415
-
};
416
-
417
-
export type ExternalSharedExternalSharedModel = {
418
-
id: string;
419
-
name?: string;
420
-
};
421
-
422
-
/**
423
-
* This is a model with one property containing a reference
424
-
*/
425
-
export type ModelWithReferenceWritable = {
426
-
prop?: ModelWithPropertiesWritable;
427
-
};
428
-
429
-
/**
430
-
* This is a model with one nested property
431
-
*/
432
-
export type ModelWithPropertiesWritable = {
433
-
required: string;
434
-
string?: string;
435
-
number?: number;
436
-
boolean?: boolean;
437
-
reference?: ModelWithString;
438
-
'property with space'?: string;
439
-
default?: string;
440
-
try?: string;
441
-
};
442
-
443
-
/**
444
-
* This is a model that contains a some patterns
445
-
*/
446
-
export type ModelWithPatternWritable = {
447
-
key: string;
448
-
name: string;
449
-
id?: string;
450
-
text?: string;
451
-
patternWithSingleQuotes?: string;
452
-
patternWithNewline?: string;
453
-
patternWithBacktick?: string;
454
-
};
455
-
456
-
export type ServiceWithEmptyTagData = {
457
-
body?: never;
458
-
path?: never;
459
-
query?: never;
460
-
url: '/api/v{api-version}/no+tag';
461
-
};
462
-
463
-
export type PatchApiVbyApiVersionNoTagData = {
464
-
body?: never;
465
-
path?: never;
466
-
query?: never;
467
-
url: '/api/v{api-version}/no+tag';
468
-
};
469
-
470
-
export type PatchApiVbyApiVersionNoTagResponses = {
471
-
/**
472
-
* OK
473
-
*/
474
-
default: unknown;
475
-
};
476
-
477
-
export type FooWowData = {
478
-
body?: never;
479
-
path?: never;
480
-
query?: never;
481
-
url: '/api/v{api-version}/no+tag';
482
-
};
483
-
484
-
export type FooWowResponses = {
485
-
/**
486
-
* OK
487
-
*/
488
-
default: unknown;
489
-
};
490
-
491
-
export type DeleteCallWithoutParametersAndResponseData = {
492
-
body?: never;
493
-
path?: never;
494
-
query?: never;
495
-
url: '/api/v{api-version}/simple';
496
-
};
497
-
498
-
export type GetCallWithoutParametersAndResponseData = {
499
-
body?: never;
500
-
path?: never;
501
-
query?: never;
502
-
url: '/api/v{api-version}/simple';
503
-
};
504
-
505
-
export type HeadCallWithoutParametersAndResponseData = {
506
-
body?: never;
507
-
path?: never;
508
-
query?: never;
509
-
url: '/api/v{api-version}/simple';
510
-
};
511
-
512
-
export type OptionsCallWithoutParametersAndResponseData = {
513
-
body?: never;
514
-
path?: never;
515
-
query?: never;
516
-
url: '/api/v{api-version}/simple';
517
-
};
518
-
519
-
export type PatchCallWithoutParametersAndResponseData = {
520
-
body?: never;
521
-
path?: never;
522
-
query?: never;
523
-
url: '/api/v{api-version}/simple';
524
-
};
525
-
526
-
export type PostCallWithoutParametersAndResponseData = {
527
-
body?: never;
528
-
path?: never;
529
-
query?: never;
530
-
url: '/api/v{api-version}/simple';
531
-
};
532
-
533
-
export type PutCallWithoutParametersAndResponseData = {
534
-
body?: never;
535
-
path?: never;
536
-
query?: never;
537
-
url: '/api/v{api-version}/simple';
538
-
};
539
-
540
-
export type CallWithDescriptionsData = {
541
-
body?: never;
542
-
path?: never;
543
-
query?: {
544
-
/**
545
-
* Testing multiline comments in string: First line
546
-
* Second line
547
-
*
548
-
* Fourth line
549
-
*/
550
-
parameterWithBreaks?: string;
551
-
/**
552
-
* Testing backticks in string: `backticks` and ```multiple backticks``` should work
553
-
*/
554
-
parameterWithBackticks?: string;
555
-
/**
556
-
* Testing slashes in string: \backwards\\\ and /forwards/// should work
557
-
*/
558
-
parameterWithSlashes?: string;
559
-
/**
560
-
* Testing expression placeholders in string: ${expression} should work
561
-
*/
562
-
parameterWithExpressionPlaceholders?: string;
563
-
/**
564
-
* Testing quotes in string: 'single quote''' and "double quotes""" should work
565
-
*/
566
-
parameterWithQuotes?: string;
567
-
/**
568
-
* Testing reserved characters in string: * inline * and ** inline ** should work
569
-
*/
570
-
parameterWithReservedCharacters?: string;
571
-
};
572
-
url: '/api/v{api-version}/descriptions/';
573
-
};
574
-
575
-
export type CallWithParametersData = {
576
-
body?: never;
577
-
headers: {
578
-
/**
579
-
* This is the parameter that goes into the header
580
-
*/
581
-
parameterHeader: string;
582
-
};
583
-
path: {
584
-
/**
585
-
* This is the parameter that goes into the path
586
-
*/
587
-
parameterPath: string;
588
-
/**
589
-
* api-version should be required in standalone clients
590
-
*/
591
-
'api-version': string;
592
-
};
593
-
query: {
594
-
/**
595
-
* This is the parameter that goes into the query params
596
-
*/
597
-
parameterQuery: string;
598
-
};
599
-
url: '/api/v{api-version}/parameters/{parameterPath}';
600
-
};
601
-
602
-
export type CallWithWeirdParameterNamesData = {
603
-
/**
604
-
* This is the parameter that is sent as request body
605
-
*/
606
-
body: string;
607
-
headers: {
608
-
/**
609
-
* This is the parameter that goes into the request header
610
-
*/
611
-
'parameter.header': string;
612
-
};
613
-
path: {
614
-
/**
615
-
* This is the parameter that goes into the path
616
-
*/
617
-
'parameter.path.1'?: string;
618
-
/**
619
-
* This is the parameter that goes into the path
620
-
*/
621
-
'parameter-path-2'?: string;
622
-
/**
623
-
* This is the parameter that goes into the path
624
-
*/
625
-
'PARAMETER-PATH-3'?: string;
626
-
/**
627
-
* api-version should be required in standalone clients
628
-
*/
629
-
'api-version': string;
630
-
};
631
-
query: {
632
-
/**
633
-
* This is the parameter with a reserved keyword
634
-
*/
635
-
default?: string;
636
-
/**
637
-
* This is the parameter that goes into the request query params
638
-
*/
639
-
'parameter-query': string;
640
-
};
641
-
url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}';
642
-
};
643
-
644
-
export type CallWithDefaultParametersData = {
645
-
body?: never;
646
-
path?: never;
647
-
query: {
648
-
/**
649
-
* This is a simple string with default value
650
-
*/
651
-
parameterString: string;
652
-
/**
653
-
* This is a simple number with default value
654
-
*/
655
-
parameterNumber: number;
656
-
/**
657
-
* This is a simple boolean with default value
658
-
*/
659
-
parameterBoolean: boolean;
660
-
/**
661
-
* This is a simple enum with default value
662
-
*/
663
-
parameterEnum: 'Success' | 'Warning' | 'Error';
664
-
/**
665
-
* This is a model with one string property
666
-
*/
667
-
parameterModel: {
668
-
/**
669
-
* This is a simple string property
670
-
*/
671
-
prop?: string;
672
-
};
673
-
};
674
-
url: '/api/v{api-version}/defaults';
675
-
};
676
-
677
-
export type CallWithDefaultOptionalParametersData = {
678
-
body?: never;
679
-
path?: never;
680
-
query?: {
681
-
/**
682
-
* This is a simple string that is optional with default value
683
-
*/
684
-
parameterString?: string;
685
-
/**
686
-
* This is a simple number that is optional with default value
687
-
*/
688
-
parameterNumber?: number;
689
-
/**
690
-
* This is a simple boolean that is optional with default value
691
-
*/
692
-
parameterBoolean?: boolean;
693
-
/**
694
-
* This is a simple enum that is optional with default value
695
-
*/
696
-
parameterEnum?: 'Success' | 'Warning' | 'Error';
697
-
};
698
-
url: '/api/v{api-version}/defaults';
699
-
};
700
-
701
-
export type CallToTestOrderOfParamsData = {
702
-
body?: never;
703
-
path?: never;
704
-
query: {
705
-
/**
706
-
* This is a optional string with default
707
-
*/
708
-
parameterOptionalStringWithDefault?: string;
709
-
/**
710
-
* This is a optional string with empty default
711
-
*/
712
-
parameterOptionalStringWithEmptyDefault?: string;
713
-
/**
714
-
* This is a optional string with no default
715
-
*/
716
-
parameterOptionalStringWithNoDefault?: string;
717
-
/**
718
-
* This is a string with default
719
-
*/
720
-
parameterStringWithDefault: string;
721
-
/**
722
-
* This is a string with empty default
723
-
*/
724
-
parameterStringWithEmptyDefault: string;
725
-
/**
726
-
* This is a string with no default
727
-
*/
728
-
parameterStringWithNoDefault: string;
729
-
/**
730
-
* This is a string that can be null with no default
731
-
*/
732
-
parameterStringNullableWithNoDefault?: string | null;
733
-
/**
734
-
* This is a string that can be null with default
735
-
*/
736
-
parameterStringNullableWithDefault?: string | null;
737
-
};
738
-
url: '/api/v{api-version}/defaults';
739
-
};
740
-
741
-
export type DuplicateNameData = {
742
-
body?: never;
743
-
path?: never;
744
-
query?: never;
745
-
url: '/api/v{api-version}/duplicate';
746
-
};
747
-
748
-
export type DuplicateName2Data = {
749
-
body?: never;
750
-
path?: never;
751
-
query?: never;
752
-
url: '/api/v{api-version}/duplicate';
753
-
};
754
-
755
-
export type DuplicateName3Data = {
756
-
body?: never;
757
-
path?: never;
758
-
query?: never;
759
-
url: '/api/v{api-version}/duplicate';
760
-
};
761
-
762
-
export type DuplicateName4Data = {
763
-
body?: never;
764
-
path?: never;
765
-
query?: never;
766
-
url: '/api/v{api-version}/duplicate';
767
-
};
768
-
769
-
export type CallWithNoContentResponseData = {
770
-
body?: never;
771
-
path?: never;
772
-
query?: never;
773
-
url: '/api/v{api-version}/no-content';
774
-
};
775
-
776
-
export type CallWithNoContentResponseResponses = {
777
-
/**
778
-
* Success
779
-
*/
780
-
204: unknown;
781
-
};
782
-
783
-
export type CallWithResponseAndNoContentResponseData = {
784
-
body?: never;
785
-
path?: never;
786
-
query?: never;
787
-
url: '/api/v{api-version}/multiple-tags/response-and-no-content';
788
-
};
789
-
790
-
export type CallWithResponseAndNoContentResponseResponses = {
791
-
/**
792
-
* Response is a simple number
793
-
*/
794
-
200: number;
795
-
/**
796
-
* Success
797
-
*/
798
-
204: unknown;
799
-
};
800
-
801
-
export type CallWithResponseAndNoContentResponseResponse = CallWithResponseAndNoContentResponseResponses[keyof CallWithResponseAndNoContentResponseResponses];
802
-
803
-
export type DummyAData = {
804
-
body?: never;
805
-
path?: never;
806
-
query?: never;
807
-
url: '/api/v{api-version}/multiple-tags/a';
808
-
};
809
-
810
-
export type DummyAResponses = {
811
-
/**
812
-
* Success
813
-
*/
814
-
204: unknown;
815
-
};
816
-
817
-
export type DummyBData = {
818
-
body?: never;
819
-
path?: never;
820
-
query?: never;
821
-
url: '/api/v{api-version}/multiple-tags/b';
822
-
};
823
-
824
-
export type DummyBResponses = {
825
-
/**
826
-
* Success
827
-
*/
828
-
204: unknown;
829
-
};
830
-
831
-
export type CallWithResponseData = {
832
-
body?: never;
833
-
path?: never;
834
-
query?: never;
835
-
url: '/api/v{api-version}/response';
836
-
};
837
-
838
-
export type CallWithResponseResponses = {
839
-
/**
840
-
* Message for default response
841
-
*/
842
-
default: ModelWithString;
843
-
};
844
-
845
-
export type CallWithResponseResponse = CallWithResponseResponses[keyof CallWithResponseResponses];
846
-
847
-
export type CallWithDuplicateResponsesData = {
848
-
body?: never;
849
-
path?: never;
850
-
query?: never;
851
-
url: '/api/v{api-version}/response';
852
-
};
853
-
854
-
export type CallWithDuplicateResponsesErrors = {
855
-
/**
856
-
* Message for 500 error
857
-
*/
858
-
500: ModelWithStringError;
859
-
/**
860
-
* Message for 501 error
861
-
*/
862
-
501: ModelWithStringError;
863
-
/**
864
-
* Message for 502 error
865
-
*/
866
-
502: ModelWithStringError;
867
-
/**
868
-
* Message for default response
869
-
*/
870
-
default: ModelWithString;
871
-
};
872
-
873
-
export type CallWithDuplicateResponsesError = CallWithDuplicateResponsesErrors[keyof CallWithDuplicateResponsesErrors];
874
-
875
-
export type CallWithDuplicateResponsesResponses = {
876
-
/**
877
-
* Message for 201 response
878
-
*/
879
-
201: ModelWithString;
880
-
/**
881
-
* Message for 202 response
882
-
*/
883
-
202: ModelWithString;
884
-
};
885
-
886
-
export type CallWithDuplicateResponsesResponse = CallWithDuplicateResponsesResponses[keyof CallWithDuplicateResponsesResponses];
887
-
888
-
export type CallWithResponsesData = {
889
-
body?: never;
890
-
path?: never;
891
-
query?: never;
892
-
url: '/api/v{api-version}/response';
893
-
};
894
-
895
-
export type CallWithResponsesErrors = {
896
-
/**
897
-
* Message for 500 error
898
-
*/
899
-
500: ModelWithStringError;
900
-
/**
901
-
* Message for 501 error
902
-
*/
903
-
501: ModelWithStringError;
904
-
/**
905
-
* Message for 502 error
906
-
*/
907
-
502: ModelWithStringError;
908
-
/**
909
-
* Message for default response
910
-
*/
911
-
default: ModelWithString;
912
-
};
913
-
914
-
export type CallWithResponsesError = CallWithResponsesErrors[keyof CallWithResponsesErrors];
915
-
916
-
export type CallWithResponsesResponses = {
917
-
/**
918
-
* Message for 200 response
919
-
*/
920
-
200: {
921
-
readonly '@namespace.string'?: string;
922
-
readonly '@namespace.integer'?: number;
923
-
readonly value?: Array<ModelWithString>;
924
-
};
925
-
/**
926
-
* Message for 201 response
927
-
*/
928
-
201: ModelThatExtends;
929
-
/**
930
-
* Message for 202 response
931
-
*/
932
-
202: ModelThatExtendsExtends;
933
-
};
934
-
935
-
export type CallWithResponsesResponse = CallWithResponsesResponses[keyof CallWithResponsesResponses];
936
-
937
-
export type CollectionFormatData = {
938
-
body?: never;
939
-
path?: never;
940
-
query: {
941
-
/**
942
-
* This is an array parameter that is sent as csv format (comma-separated values)
943
-
*/
944
-
parameterArrayCSV: Array<string>;
945
-
/**
946
-
* This is an array parameter that is sent as ssv format (space-separated values)
947
-
*/
948
-
parameterArraySSV: Array<string>;
949
-
/**
950
-
* This is an array parameter that is sent as tsv format (tab-separated values)
951
-
*/
952
-
parameterArrayTSV: Array<string>;
953
-
/**
954
-
* This is an array parameter that is sent as pipes format (pipe-separated values)
955
-
*/
956
-
parameterArrayPipes: Array<string>;
957
-
/**
958
-
* This is an array parameter that is sent as multi format (multiple parameter instances)
959
-
*/
960
-
parameterArrayMulti: Array<string>;
961
-
};
962
-
url: '/api/v{api-version}/collectionFormat';
963
-
};
964
-
965
-
export type TypesData = {
966
-
body?: never;
967
-
path?: {
968
-
/**
969
-
* This is a number parameter
970
-
*/
971
-
id?: number;
972
-
};
973
-
query: {
974
-
/**
975
-
* This is a number parameter
976
-
*/
977
-
parameterNumber: number;
978
-
/**
979
-
* This is a string parameter
980
-
*/
981
-
parameterString: string;
982
-
/**
983
-
* This is a boolean parameter
984
-
*/
985
-
parameterBoolean: boolean;
986
-
/**
987
-
* This is an array parameter
988
-
*/
989
-
parameterArray: Array<string>;
990
-
/**
991
-
* This is a dictionary parameter
992
-
*/
993
-
parameterDictionary: {
994
-
[key: string]: unknown;
995
-
};
996
-
/**
997
-
* This is an enum parameter
998
-
*/
999
-
parameterEnum: 'Success' | 'Warning' | 'Error';
1000
-
};
1001
-
url: '/api/v{api-version}/types';
1002
-
};
1003
-
1004
-
export type TypesResponses = {
1005
-
/**
1006
-
* Response is a simple number
1007
-
*/
1008
-
200: number;
1009
-
/**
1010
-
* Response is a simple string
1011
-
*/
1012
-
201: string;
1013
-
/**
1014
-
* Response is a simple boolean
1015
-
*/
1016
-
202: boolean;
1017
-
/**
1018
-
* Response is a simple object
1019
-
*/
1020
-
203: {
1021
-
[key: string]: unknown;
1022
-
};
1023
-
};
1024
-
1025
-
export type TypesResponse = TypesResponses[keyof TypesResponses];
1026
-
1027
-
export type ComplexTypesData = {
1028
-
body?: never;
1029
-
path?: never;
1030
-
query: {
1031
-
/**
1032
-
* Parameter containing object
1033
-
*/
1034
-
parameterObject: {
1035
-
first?: {
1036
-
second?: {
1037
-
third?: string;
1038
-
};
1039
-
};
1040
-
};
1041
-
/**
1042
-
* This is a model with one string property
1043
-
*/
1044
-
parameterReference: {
1045
-
/**
1046
-
* This is a simple string property
1047
-
*/
1048
-
prop?: string;
1049
-
};
1050
-
};
1051
-
url: '/api/v{api-version}/complex';
1052
-
};
1053
-
1054
-
export type ComplexTypesErrors = {
1055
-
/**
1056
-
* 400 server error
1057
-
*/
1058
-
400: unknown;
1059
-
/**
1060
-
* 500 server error
1061
-
*/
1062
-
500: unknown;
1063
-
};
1064
-
1065
-
export type ComplexTypesResponses = {
1066
-
/**
1067
-
* Successful response
1068
-
*/
1069
-
200: Array<ModelWithString>;
1070
-
};
1071
-
1072
-
export type ComplexTypesResponse = ComplexTypesResponses[keyof ComplexTypesResponses];
1073
-
1074
-
export type CallWithResultFromHeaderData = {
1075
-
body?: never;
1076
-
path?: never;
1077
-
query?: never;
1078
-
url: '/api/v{api-version}/header';
1079
-
};
1080
-
1081
-
export type CallWithResultFromHeaderErrors = {
1082
-
/**
1083
-
* 400 server error
1084
-
*/
1085
-
400: unknown;
1086
-
/**
1087
-
* 500 server error
1088
-
*/
1089
-
500: unknown;
1090
-
};
1091
-
1092
-
export type CallWithResultFromHeaderResponses = {
1093
-
/**
1094
-
* Successful response
1095
-
*/
1096
-
200: unknown;
1097
-
};
1098
-
1099
-
export type TestErrorCodeData = {
1100
-
body?: never;
1101
-
path?: never;
1102
-
query: {
1103
-
/**
1104
-
* Status code to return
1105
-
*/
1106
-
status: string;
1107
-
};
1108
-
url: '/api/v{api-version}/error';
1109
-
};
1110
-
1111
-
export type TestErrorCodeErrors = {
1112
-
/**
1113
-
* Custom message: Internal Server Error
1114
-
*/
1115
-
500: unknown;
1116
-
/**
1117
-
* Custom message: Not Implemented
1118
-
*/
1119
-
501: unknown;
1120
-
/**
1121
-
* Custom message: Bad Gateway
1122
-
*/
1123
-
502: unknown;
1124
-
/**
1125
-
* Custom message: Service Unavailable
1126
-
*/
1127
-
503: unknown;
1128
-
};
1129
-
1130
-
export type TestErrorCodeResponses = {
1131
-
/**
1132
-
* Custom message: Successful response
1133
-
*/
1134
-
200: unknown;
1135
-
};
1136
-
1137
-
export type NonAsciiæøåÆøÅöôêÊ字符串Data = {
1138
-
body?: never;
1139
-
path?: never;
1140
-
query: {
1141
-
/**
1142
-
* Dummy input param
1143
-
*/
1144
-
nonAsciiParamæøåÆØÅöôêÊ: number;
1145
-
};
1146
-
url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串';
1147
-
};
1148
-
1149
-
export type NonAsciiæøåÆøÅöôêÊ字符串Responses = {
1150
-
/**
1151
-
* Successful response
1152
-
*/
1153
-
200: NonAsciiStringæøåÆøÅöôêÊ字符串;
1154
-
};
1155
-
1156
-
export type NonAsciiæøåÆøÅöôêÊ字符串Response = NonAsciiæøåÆøÅöôêÊ字符串Responses[keyof NonAsciiæøåÆøÅöôêÊ字符串Responses];
1157
-
1158
-
export type PostApiVbyApiVersionBodyData = {
1159
-
/**
1160
-
* Body should not be unknown
1161
-
*/
1162
-
body: ParameterActivityParams;
1163
-
path?: never;
1164
-
query?: never;
1165
-
url: '/api/v{api-version}/body';
1166
-
};
1167
-
1168
-
export type PostApiVbyApiVersionBodyErrors = {
1169
-
/**
1170
-
* Bad Request
1171
-
*/
1172
-
400: FailureFailure;
1173
-
/**
1174
-
* Internal Server Error
1175
-
*/
1176
-
500: FailureFailure;
1177
-
};
1178
-
1179
-
export type PostApiVbyApiVersionBodyError = PostApiVbyApiVersionBodyErrors[keyof PostApiVbyApiVersionBodyErrors];
1180
-
1181
-
export type PostApiVbyApiVersionBodyResponses = {
1182
-
/**
1183
-
* OK
1184
-
*/
1185
-
200: ResponsePostActivityResponse;
1186
-
};
1187
-
1188
-
export type PostApiVbyApiVersionBodyResponse = PostApiVbyApiVersionBodyResponses[keyof PostApiVbyApiVersionBodyResponses];
+67
-7
packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/plugins/nestjs/default/nestjs.gen.ts
+67
-7
packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/plugins/nestjs/default/nestjs.gen.ts
···
2
2
3
3
import type { ApiVVersionODataControllerCountResponse, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesResponse, CallWithNoContentResponseResponse, CallWithParametersData, CallWithResponseAndNoContentResponseResponse, CallWithResponseResponse, CallWithResponsesResponse, CallWithWeirdParameterNamesData, CollectionFormatData, ComplexParamsData, ComplexParamsResponse, ComplexTypesData, ComplexTypesResponse, DeleteFooData3, DeprecatedCallData, DummyAResponse, DummyBResponse, FileResponseData, FileResponseResponse, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationResponse, GetCallWithOptionalParamData, ImportData, ImportResponse, MultipartRequestData, MultipartResponseResponse, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponse, PutWithFormUrlEncodedData, TestErrorCodeData, TypesData, TypesResponse, UploadFileData, UploadFileResponse } from './types.gen';
4
4
5
-
export type ControllerMethods = {
5
+
export type DefaultControllerMethods = {
6
6
export: () => Promise<void>;
7
7
patchApiVbyApiVersionNoTag: () => Promise<void>;
8
8
import: (body: ImportData['body']) => Promise<ImportResponse>;
9
9
fooWow: () => Promise<void>;
10
-
apiVVersionODataControllerCount: () => Promise<ApiVVersionODataControllerCountResponse>;
11
10
getApiVbyApiVersionSimpleOperation: (path: GetApiVbyApiVersionSimpleOperationData['path']) => Promise<GetApiVbyApiVersionSimpleOperationResponse>;
11
+
};
12
+
13
+
export type SimpleControllerMethods = {
14
+
apiVVersionODataControllerCount: () => Promise<ApiVVersionODataControllerCountResponse>;
12
15
deleteCallWithoutParametersAndResponse: () => Promise<void>;
13
16
getCallWithoutParametersAndResponse: () => Promise<void>;
14
17
headCallWithoutParametersAndResponse: () => Promise<void>;
···
16
19
patchCallWithoutParametersAndResponse: () => Promise<void>;
17
20
postCallWithoutParametersAndResponse: () => Promise<void>;
18
21
putCallWithoutParametersAndResponse: () => Promise<void>;
22
+
};
23
+
24
+
export type ParametersControllerMethods = {
19
25
deleteFoo: (path: DeleteFooData3['path'], headers: DeleteFooData3['headers']) => Promise<void>;
20
-
callWithDescriptions: (query?: CallWithDescriptionsData['query']) => Promise<void>;
21
-
deprecatedCall: (headers: DeprecatedCallData['headers']) => Promise<void>;
22
26
callWithParameters: (path: CallWithParametersData['path'], query: CallWithParametersData['query'], body: CallWithParametersData['body'], headers: CallWithParametersData['headers']) => Promise<void>;
23
27
callWithWeirdParameterNames: (path: CallWithWeirdParameterNamesData['path'], query: CallWithWeirdParameterNamesData['query'], body: CallWithWeirdParameterNamesData['body'], headers: CallWithWeirdParameterNamesData['headers']) => Promise<void>;
24
28
getCallWithOptionalParam: (body: GetCallWithOptionalParamData['body'], query?: GetCallWithOptionalParamData['query']) => Promise<void>;
25
29
postCallWithOptionalParam: (query: PostCallWithOptionalParamData['query'], body?: PostCallWithOptionalParamData['body']) => Promise<PostCallWithOptionalParamResponse>;
30
+
};
31
+
32
+
export type DescriptionsControllerMethods = {
33
+
callWithDescriptions: (query?: CallWithDescriptionsData['query']) => Promise<void>;
34
+
};
35
+
36
+
export type DeprecatedControllerMethods = {
37
+
deprecatedCall: (headers: DeprecatedCallData['headers']) => Promise<void>;
38
+
};
39
+
40
+
export type RequestBodyControllerMethods = {
26
41
postApiVbyApiVersionRequestBody: (query?: PostApiVbyApiVersionRequestBodyData['query'], body?: PostApiVbyApiVersionRequestBodyData['body']) => Promise<void>;
42
+
};
43
+
44
+
export type FormDataControllerMethods = {
27
45
postApiVbyApiVersionFormData: (query?: PostApiVbyApiVersionFormDataData['query'], body?: PostApiVbyApiVersionFormDataData['body']) => Promise<void>;
46
+
};
47
+
48
+
export type DefaultsControllerMethods = {
28
49
callWithDefaultParameters: (query?: CallWithDefaultParametersData['query']) => Promise<void>;
29
50
callWithDefaultOptionalParameters: (query?: CallWithDefaultOptionalParametersData['query']) => Promise<void>;
30
51
callToTestOrderOfParams: (query: CallToTestOrderOfParamsData['query']) => Promise<void>;
52
+
};
53
+
54
+
export type DuplicateControllerMethods = {
31
55
duplicateName: () => Promise<void>;
32
56
duplicateName2: () => Promise<void>;
33
57
duplicateName3: () => Promise<void>;
34
58
duplicateName4: () => Promise<void>;
59
+
};
60
+
61
+
export type NoContentControllerMethods = {
35
62
callWithNoContentResponse: () => Promise<CallWithNoContentResponseResponse>;
63
+
};
64
+
65
+
export type ResponseControllerMethods = {
36
66
callWithResponseAndNoContentResponse: () => Promise<CallWithResponseAndNoContentResponseResponse>;
37
-
dummyA: () => Promise<DummyAResponse>;
38
-
dummyB: () => Promise<DummyBResponse>;
39
67
callWithResponse: () => Promise<CallWithResponseResponse>;
40
68
callWithDuplicateResponses: () => Promise<CallWithDuplicateResponsesResponse>;
41
69
callWithResponses: () => Promise<CallWithResponsesResponse>;
70
+
};
71
+
72
+
export type MultipleTags1ControllerMethods = {
73
+
dummyA: () => Promise<DummyAResponse>;
74
+
dummyB: () => Promise<DummyBResponse>;
75
+
};
76
+
77
+
export type CollectionFormatControllerMethods = {
42
78
collectionFormat: (query: CollectionFormatData['query']) => Promise<void>;
79
+
};
80
+
81
+
export type TypesControllerMethods = {
43
82
types: (query: TypesData['query'], path?: TypesData['path']) => Promise<TypesResponse>;
83
+
};
84
+
85
+
export type UploadControllerMethods = {
44
86
uploadFile: (path: UploadFileData['path'], body: UploadFileData['body']) => Promise<UploadFileResponse>;
87
+
};
88
+
89
+
export type FileResponseControllerMethods = {
45
90
fileResponse: (path: FileResponseData['path']) => Promise<FileResponseResponse>;
91
+
};
92
+
93
+
export type ComplexControllerMethods = {
46
94
complexTypes: (query: ComplexTypesData['query']) => Promise<ComplexTypesResponse>;
95
+
complexParams: (path: ComplexParamsData['path'], body?: ComplexParamsData['body']) => Promise<ComplexParamsResponse>;
96
+
};
97
+
98
+
export type MultipartControllerMethods = {
47
99
multipartResponse: () => Promise<MultipartResponseResponse>;
48
100
multipartRequest: (body?: MultipartRequestData['body']) => Promise<void>;
49
-
complexParams: (path: ComplexParamsData['path'], body?: ComplexParamsData['body']) => Promise<ComplexParamsResponse>;
101
+
};
102
+
103
+
export type HeaderControllerMethods = {
50
104
callWithResultFromHeader: () => Promise<void>;
105
+
};
106
+
107
+
export type ErrorControllerMethods = {
51
108
testErrorCode: (query: TestErrorCodeData['query']) => Promise<void>;
109
+
};
110
+
111
+
export type NonAsciiÆøåÆøÅöôêÊControllerMethods = {
52
112
nonAsciiæøåÆøÅöôêÊ字符串: (query: NonAsciiæøåÆøÅöôêÊ字符串Data['query']) => Promise<NonAsciiæøåÆøÅöôêÊ字符串Response>;
53
113
putWithFormUrlEncoded: (body: PutWithFormUrlEncodedData['body']) => Promise<void>;
54
114
};
-3
packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/plugins/nestjs/group-by-tag/index.ts
-3
packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/plugins/nestjs/group-by-tag/index.ts
···
1
-
// This file is auto-generated by @hey-api/openapi-ts
2
-
3
-
export type { _3eNum1Период, _400, AdditionalPropertiesIntegerIssue, AdditionalPropertiesUnknownIssue, AdditionalPropertiesUnknownIssue2, AdditionalPropertiesUnknownIssue3, AdditionalPropertiesUnknownIssueWritable, AnyOfAnyAndNull, AnyOfArrays, ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponse, ApiVVersionODataControllerCountResponses, ArrayWithAnyOfProperties, ArrayWithArray, ArrayWithBooleans, ArrayWithNumbers, ArrayWithProperties, ArrayWithReferences, ArrayWithStrings, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesError, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponse, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponse, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponse, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesError, CallWithResponsesErrors, CallWithResponsesResponse, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, CamelCaseCommentWithBreaks, CharactersInDescription, ClientOptions, CollectionFormatData, CommentWithBackticks, CommentWithBackticksAndQuotes, CommentWithBreaks, CommentWithExpressionPlaceholders, CommentWithQuotes, CommentWithReservedCharacters, CommentWithSlashes, ComplexParamsData, ComplexParamsResponse, ComplexParamsResponses, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponse, ComplexTypesResponses, CompositionBaseModel, CompositionExtendedModel, CompositionWithAllOfAndNullable, CompositionWithAnyOf, CompositionWithAnyOfAndNullable, CompositionWithAnyOfAnonymous, CompositionWithNestedAnyAndTypeNull, CompositionWithNestedAnyOfAndNull, CompositionWithOneOf, CompositionWithOneOfAndComplexArrayDictionary, CompositionWithOneOfAndNullable, CompositionWithOneOfAndProperties, CompositionWithOneOfAndSimpleArrayDictionary, CompositionWithOneOfAndSimpleDictionary, CompositionWithOneOfAnonymous, CompositionWithOneOfDiscriminator, ConstValue, Default, DeleteCallWithoutParametersAndResponseData, DeleteFooData, DeleteFooData2, DeleteFooData3, DeprecatedCallData, DeprecatedModel, DictionaryWithArray, DictionaryWithDictionary, DictionaryWithProperties, DictionaryWithPropertiesAndAdditionalProperties, DictionaryWithReference, DictionaryWithString, DummyAData, DummyAResponse, DummyAResponses, DummyBData, DummyBResponse, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, EnumFromDescription, EnumWithExtensions, EnumWithNumbers, EnumWithReplacedCharacters, EnumWithStrings, EnumWithXEnumNames, ExportData, ExternalRefA, ExternalRefB, ExternalSharedExternalSharedModel, File, FileResponseData, FileResponseResponse, FileResponseResponses, FileWritable, FooWowData, FooWowResponses, FreeFormObjectWithAdditionalPropertiesEqEmptyObject, FreeFormObjectWithAdditionalPropertiesEqTrue, FreeFormObjectWithoutAdditionalProperties, GenericSchemaDuplicateIssue1SystemBoolean, GenericSchemaDuplicateIssue1SystemBooleanWritable, GenericSchemaDuplicateIssue1SystemString, GenericSchemaDuplicateIssue1SystemStringWritable, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationError, GetApiVbyApiVersionSimpleOperationErrors, GetApiVbyApiVersionSimpleOperationResponse, GetApiVbyApiVersionSimpleOperationResponses, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, Import, ImportData, ImportResponse, ImportResponses, IoK8sApimachineryPkgApisMetaV1DeleteOptions, IoK8sApimachineryPkgApisMetaV1Preconditions, ModelCircle, ModelFromZendesk, ModelSquare, ModelThatExtends, ModelThatExtendsExtends, ModelWithAdditionalPropertiesEqTrue, ModelWithAnyOfConstantSizeArray, ModelWithAnyOfConstantSizeArrayAndIntersect, ModelWithAnyOfConstantSizeArrayNullable, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable, ModelWithArray, ModelWithArrayReadOnlyAndWriteOnly, ModelWithArrayReadOnlyAndWriteOnlyWritable, ModelWithBackticksInDescription, ModelWithBoolean, ModelWithCircularReference, ModelWithConst, ModelWithConstantSizeArray, ModelWithDictionary, ModelWithDuplicateImports, ModelWithDuplicateProperties, ModelWithEnum, ModelWithEnumFromDescription, ModelWithEnumWithHyphen, ModelWithInteger, ModelWithNestedArrayEnums, ModelWithNestedArrayEnumsData, ModelWithNestedArrayEnumsDataBar, ModelWithNestedArrayEnumsDataFoo, ModelWithNestedCompositionEnums, ModelWithNestedEnums, ModelWithNestedProperties, ModelWithNullableObject, ModelWithNullableString, ModelWithNumericEnumUnion, ModelWithOneOfAndProperties, ModelWithOneOfEnum, ModelWithOrderedProperties, ModelWithPattern, ModelWithPatternWritable, ModelWithPrefixItemsConstantSizeArray, ModelWithProperties, ModelWithPropertiesWritable, ModelWithReadOnlyAndWriteOnly, ModelWithReadOnlyAndWriteOnlyWritable, ModelWithReference, ModelWithReferenceWritable, ModelWithString, ModelWithStringError, MultipartRequestData, MultipartResponseData, MultipartResponseResponse, MultipartResponseResponses, NestedAnyOfArraysNullable, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, NonAsciiæøåÆøÅöôêÊ字符串Responses, NonAsciiStringæøåÆøÅöôêÊ字符串, NullableObject, OneOfAllOfIssue, OneOfAllOfIssueWritable, OptionsCallWithoutParametersAndResponseData, Pageable, ParameterSimpleParameterUnused, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponse, PostCallWithOptionalParamResponses, PostCallWithoutParametersAndResponseData, PostServiceWithEmptyTagResponse, PostServiceWithEmptyTagResponse2, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, SchemaWithFormRestrictedKeys, SimpleBoolean, SimpleFile, SimpleFormData, SimpleInteger, SimpleParameter, SimpleReference, SimpleRequestBody, SimpleString, SimpleStringWithPattern, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponse, TypesResponses, UploadFileData, UploadFileResponse, UploadFileResponses, XFooBar } from './types.gen';
-114
packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/plugins/nestjs/group-by-tag/nestjs.gen.ts
-114
packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/plugins/nestjs/group-by-tag/nestjs.gen.ts
···
1
-
// This file is auto-generated by @hey-api/openapi-ts
2
-
3
-
import type { ApiVVersionODataControllerCountResponse, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesResponse, CallWithNoContentResponseResponse, CallWithParametersData, CallWithResponseAndNoContentResponseResponse, CallWithResponseResponse, CallWithResponsesResponse, CallWithWeirdParameterNamesData, CollectionFormatData, ComplexParamsData, ComplexParamsResponse, ComplexTypesData, ComplexTypesResponse, DeleteFooData3, DeprecatedCallData, DummyAResponse, DummyBResponse, FileResponseData, FileResponseResponse, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationResponse, GetCallWithOptionalParamData, ImportData, ImportResponse, MultipartRequestData, MultipartResponseResponse, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponse, PutWithFormUrlEncodedData, TestErrorCodeData, TypesData, TypesResponse, UploadFileData, UploadFileResponse } from './types.gen';
4
-
5
-
export type DefaultControllerMethods = {
6
-
export: () => Promise<void>;
7
-
patchApiVbyApiVersionNoTag: () => Promise<void>;
8
-
import: (body: ImportData['body']) => Promise<ImportResponse>;
9
-
fooWow: () => Promise<void>;
10
-
getApiVbyApiVersionSimpleOperation: (path: GetApiVbyApiVersionSimpleOperationData['path']) => Promise<GetApiVbyApiVersionSimpleOperationResponse>;
11
-
};
12
-
13
-
export type SimpleControllerMethods = {
14
-
apiVVersionODataControllerCount: () => Promise<ApiVVersionODataControllerCountResponse>;
15
-
deleteCallWithoutParametersAndResponse: () => Promise<void>;
16
-
getCallWithoutParametersAndResponse: () => Promise<void>;
17
-
headCallWithoutParametersAndResponse: () => Promise<void>;
18
-
optionsCallWithoutParametersAndResponse: () => Promise<void>;
19
-
patchCallWithoutParametersAndResponse: () => Promise<void>;
20
-
postCallWithoutParametersAndResponse: () => Promise<void>;
21
-
putCallWithoutParametersAndResponse: () => Promise<void>;
22
-
};
23
-
24
-
export type ParametersControllerMethods = {
25
-
deleteFoo: (path: DeleteFooData3['path'], headers: DeleteFooData3['headers']) => Promise<void>;
26
-
callWithParameters: (path: CallWithParametersData['path'], query: CallWithParametersData['query'], body: CallWithParametersData['body'], headers: CallWithParametersData['headers']) => Promise<void>;
27
-
callWithWeirdParameterNames: (path: CallWithWeirdParameterNamesData['path'], query: CallWithWeirdParameterNamesData['query'], body: CallWithWeirdParameterNamesData['body'], headers: CallWithWeirdParameterNamesData['headers']) => Promise<void>;
28
-
getCallWithOptionalParam: (body: GetCallWithOptionalParamData['body'], query?: GetCallWithOptionalParamData['query']) => Promise<void>;
29
-
postCallWithOptionalParam: (query: PostCallWithOptionalParamData['query'], body?: PostCallWithOptionalParamData['body']) => Promise<PostCallWithOptionalParamResponse>;
30
-
};
31
-
32
-
export type DescriptionsControllerMethods = {
33
-
callWithDescriptions: (query?: CallWithDescriptionsData['query']) => Promise<void>;
34
-
};
35
-
36
-
export type DeprecatedControllerMethods = {
37
-
deprecatedCall: (headers: DeprecatedCallData['headers']) => Promise<void>;
38
-
};
39
-
40
-
export type RequestBodyControllerMethods = {
41
-
postApiVbyApiVersionRequestBody: (query?: PostApiVbyApiVersionRequestBodyData['query'], body?: PostApiVbyApiVersionRequestBodyData['body']) => Promise<void>;
42
-
};
43
-
44
-
export type FormDataControllerMethods = {
45
-
postApiVbyApiVersionFormData: (query?: PostApiVbyApiVersionFormDataData['query'], body?: PostApiVbyApiVersionFormDataData['body']) => Promise<void>;
46
-
};
47
-
48
-
export type DefaultsControllerMethods = {
49
-
callWithDefaultParameters: (query?: CallWithDefaultParametersData['query']) => Promise<void>;
50
-
callWithDefaultOptionalParameters: (query?: CallWithDefaultOptionalParametersData['query']) => Promise<void>;
51
-
callToTestOrderOfParams: (query: CallToTestOrderOfParamsData['query']) => Promise<void>;
52
-
};
53
-
54
-
export type DuplicateControllerMethods = {
55
-
duplicateName: () => Promise<void>;
56
-
duplicateName2: () => Promise<void>;
57
-
duplicateName3: () => Promise<void>;
58
-
duplicateName4: () => Promise<void>;
59
-
};
60
-
61
-
export type NoContentControllerMethods = {
62
-
callWithNoContentResponse: () => Promise<CallWithNoContentResponseResponse>;
63
-
};
64
-
65
-
export type ResponseControllerMethods = {
66
-
callWithResponseAndNoContentResponse: () => Promise<CallWithResponseAndNoContentResponseResponse>;
67
-
callWithResponse: () => Promise<CallWithResponseResponse>;
68
-
callWithDuplicateResponses: () => Promise<CallWithDuplicateResponsesResponse>;
69
-
callWithResponses: () => Promise<CallWithResponsesResponse>;
70
-
};
71
-
72
-
export type MultipleTags1ControllerMethods = {
73
-
dummyA: () => Promise<DummyAResponse>;
74
-
dummyB: () => Promise<DummyBResponse>;
75
-
};
76
-
77
-
export type CollectionFormatControllerMethods = {
78
-
collectionFormat: (query: CollectionFormatData['query']) => Promise<void>;
79
-
};
80
-
81
-
export type TypesControllerMethods = {
82
-
types: (query: TypesData['query'], path?: TypesData['path']) => Promise<TypesResponse>;
83
-
};
84
-
85
-
export type UploadControllerMethods = {
86
-
uploadFile: (path: UploadFileData['path'], body: UploadFileData['body']) => Promise<UploadFileResponse>;
87
-
};
88
-
89
-
export type FileResponseControllerMethods = {
90
-
fileResponse: (path: FileResponseData['path']) => Promise<FileResponseResponse>;
91
-
};
92
-
93
-
export type ComplexControllerMethods = {
94
-
complexTypes: (query: ComplexTypesData['query']) => Promise<ComplexTypesResponse>;
95
-
complexParams: (path: ComplexParamsData['path'], body?: ComplexParamsData['body']) => Promise<ComplexParamsResponse>;
96
-
};
97
-
98
-
export type MultipartControllerMethods = {
99
-
multipartResponse: () => Promise<MultipartResponseResponse>;
100
-
multipartRequest: (body?: MultipartRequestData['body']) => Promise<void>;
101
-
};
102
-
103
-
export type HeaderControllerMethods = {
104
-
callWithResultFromHeader: () => Promise<void>;
105
-
};
106
-
107
-
export type ErrorControllerMethods = {
108
-
testErrorCode: (query: TestErrorCodeData['query']) => Promise<void>;
109
-
};
110
-
111
-
export type NonAsciiÆøåÆøÅöôêÊControllerMethods = {
112
-
nonAsciiæøåÆøÅöôêÊ字符串: (query: NonAsciiæøåÆøÅöôêÊ字符串Data['query']) => Promise<NonAsciiæøåÆøÅöôêÊ字符串Response>;
113
-
putWithFormUrlEncoded: (body: PutWithFormUrlEncodedData['body']) => Promise<void>;
114
-
};
-2072
packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/plugins/nestjs/group-by-tag/types.gen.ts
-2072
packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/plugins/nestjs/group-by-tag/types.gen.ts
···
1
-
// This file is auto-generated by @hey-api/openapi-ts
2
-
3
-
export type ClientOptions = {
4
-
baseUrl: 'http://localhost:3000/base' | (string & {});
5
-
};
6
-
7
-
/**
8
-
* Model with number-only name
9
-
*/
10
-
export type _400 = string;
11
-
12
-
export type ExternalRefA = ExternalSharedExternalSharedModel;
13
-
14
-
export type ExternalRefB = ExternalSharedExternalSharedModel;
15
-
16
-
/**
17
-
* Testing multiline comments in string: First line
18
-
* Second line
19
-
*
20
-
* Fourth line
21
-
*/
22
-
export type CamelCaseCommentWithBreaks = number;
23
-
24
-
/**
25
-
* Testing multiline comments in string: First line
26
-
* Second line
27
-
*
28
-
* Fourth line
29
-
*/
30
-
export type CommentWithBreaks = number;
31
-
32
-
/**
33
-
* Testing backticks in string: `backticks` and ```multiple backticks``` should work
34
-
*/
35
-
export type CommentWithBackticks = number;
36
-
37
-
/**
38
-
* Testing backticks and quotes in string: `backticks`, 'quotes', "double quotes" and ```multiple backticks``` should work
39
-
*/
40
-
export type CommentWithBackticksAndQuotes = number;
41
-
42
-
/**
43
-
* Testing slashes in string: \backwards\\\ and /forwards/// should work
44
-
*/
45
-
export type CommentWithSlashes = number;
46
-
47
-
/**
48
-
* Testing expression placeholders in string: ${expression} should work
49
-
*/
50
-
export type CommentWithExpressionPlaceholders = number;
51
-
52
-
/**
53
-
* Testing quotes in string: 'single quote''' and "double quotes""" should work
54
-
*/
55
-
export type CommentWithQuotes = number;
56
-
57
-
/**
58
-
* Testing reserved characters in string: * inline * and ** inline ** should work
59
-
*/
60
-
export type CommentWithReservedCharacters = number;
61
-
62
-
/**
63
-
* This is a simple number
64
-
*/
65
-
export type SimpleInteger = number;
66
-
67
-
/**
68
-
* This is a simple boolean
69
-
*/
70
-
export type SimpleBoolean = boolean;
71
-
72
-
/**
73
-
* This is a simple string
74
-
*/
75
-
export type SimpleString = string;
76
-
77
-
/**
78
-
* A string with non-ascii (unicode) characters valid in typescript identifiers (æøåÆØÅöÔèÈ字符串)
79
-
*/
80
-
export type NonAsciiStringæøåÆøÅöôêÊ字符串 = string;
81
-
82
-
/**
83
-
* This is a simple file
84
-
*/
85
-
export type SimpleFile = Blob | File;
86
-
87
-
/**
88
-
* This is a simple reference
89
-
*/
90
-
export type SimpleReference = ModelWithString;
91
-
92
-
/**
93
-
* This is a simple string
94
-
*/
95
-
export type SimpleStringWithPattern = string | null;
96
-
97
-
/**
98
-
* This is a simple enum with strings
99
-
*/
100
-
export type EnumWithStrings = 'Success' | 'Warning' | 'Error' | '\'Single Quote\'' | '"Double Quotes"' | 'Non-ascii: øæåôöØÆÅÔÖ字符串';
101
-
102
-
export type EnumWithReplacedCharacters = '\'Single Quote\'' | '"Double Quotes"' | 'øæåôöØÆÅÔÖ字符串' | 3.1 | '';
103
-
104
-
/**
105
-
* This is a simple enum with numbers
106
-
*/
107
-
export type EnumWithNumbers = 1 | 2 | 3 | 1.1 | 1.2 | 1.3 | 100 | 200 | 300 | -100 | -200 | -300 | -1.1 | -1.2 | -1.3;
108
-
109
-
/**
110
-
* Success=1,Warning=2,Error=3
111
-
*/
112
-
export type EnumFromDescription = number;
113
-
114
-
/**
115
-
* This is a simple enum with numbers
116
-
*/
117
-
export type EnumWithExtensions = 200 | 400 | 500;
118
-
119
-
export type EnumWithXEnumNames = 0 | 1 | 2;
120
-
121
-
/**
122
-
* This is a simple array with numbers
123
-
*/
124
-
export type ArrayWithNumbers = Array<number>;
125
-
126
-
/**
127
-
* This is a simple array with booleans
128
-
*/
129
-
export type ArrayWithBooleans = Array<boolean>;
130
-
131
-
/**
132
-
* This is a simple array with strings
133
-
*/
134
-
export type ArrayWithStrings = Array<string>;
135
-
136
-
/**
137
-
* This is a simple array with references
138
-
*/
139
-
export type ArrayWithReferences = Array<ModelWithString>;
140
-
141
-
/**
142
-
* This is a simple array containing an array
143
-
*/
144
-
export type ArrayWithArray = Array<Array<ModelWithString>>;
145
-
146
-
/**
147
-
* This is a simple array with properties
148
-
*/
149
-
export type ArrayWithProperties = Array<{
150
-
'16x16'?: CamelCaseCommentWithBreaks;
151
-
bar?: string;
152
-
}>;
153
-
154
-
/**
155
-
* This is a simple array with any of properties
156
-
*/
157
-
export type ArrayWithAnyOfProperties = Array<{
158
-
foo?: string;
159
-
} | {
160
-
bar?: string;
161
-
}>;
162
-
163
-
export type AnyOfAnyAndNull = {
164
-
data?: unknown;
165
-
};
166
-
167
-
/**
168
-
* This is a simple array with any of properties
169
-
*/
170
-
export type AnyOfArrays = {
171
-
results?: Array<{
172
-
foo?: string;
173
-
} | {
174
-
bar?: string;
175
-
}>;
176
-
};
177
-
178
-
/**
179
-
* This is a string dictionary
180
-
*/
181
-
export type DictionaryWithString = {
182
-
[key: string]: string;
183
-
};
184
-
185
-
export type DictionaryWithPropertiesAndAdditionalProperties = {
186
-
foo?: number;
187
-
bar?: boolean;
188
-
[key: string]: string | number | boolean | undefined;
189
-
};
190
-
191
-
/**
192
-
* This is a string reference
193
-
*/
194
-
export type DictionaryWithReference = {
195
-
[key: string]: ModelWithString;
196
-
};
197
-
198
-
/**
199
-
* This is a complex dictionary
200
-
*/
201
-
export type DictionaryWithArray = {
202
-
[key: string]: Array<ModelWithString>;
203
-
};
204
-
205
-
/**
206
-
* This is a string dictionary
207
-
*/
208
-
export type DictionaryWithDictionary = {
209
-
[key: string]: {
210
-
[key: string]: string;
211
-
};
212
-
};
213
-
214
-
/**
215
-
* This is a complex dictionary
216
-
*/
217
-
export type DictionaryWithProperties = {
218
-
[key: string]: {
219
-
foo?: string;
220
-
bar?: string;
221
-
};
222
-
};
223
-
224
-
/**
225
-
* This is a model with one number property
226
-
*/
227
-
export type ModelWithInteger = {
228
-
/**
229
-
* This is a simple number property
230
-
*/
231
-
prop?: number;
232
-
};
233
-
234
-
/**
235
-
* This is a model with one boolean property
236
-
*/
237
-
export type ModelWithBoolean = {
238
-
/**
239
-
* This is a simple boolean property
240
-
*/
241
-
prop?: boolean;
242
-
};
243
-
244
-
/**
245
-
* This is a model with one string property
246
-
*/
247
-
export type ModelWithString = {
248
-
/**
249
-
* This is a simple string property
250
-
*/
251
-
prop?: string;
252
-
};
253
-
254
-
/**
255
-
* This is a model with one string property
256
-
*/
257
-
export type ModelWithStringError = {
258
-
/**
259
-
* This is a simple string property
260
-
*/
261
-
prop?: string;
262
-
};
263
-
264
-
/**
265
-
* `Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets)
266
-
*/
267
-
export type ModelFromZendesk = string;
268
-
269
-
/**
270
-
* This is a model with one string property
271
-
*/
272
-
export type ModelWithNullableString = {
273
-
/**
274
-
* This is a simple string property
275
-
*/
276
-
nullableProp1?: string | null;
277
-
/**
278
-
* This is a simple string property
279
-
*/
280
-
nullableRequiredProp1: string | null;
281
-
/**
282
-
* This is a simple string property
283
-
*/
284
-
nullableProp2?: string | null;
285
-
/**
286
-
* This is a simple string property
287
-
*/
288
-
nullableRequiredProp2: string | null;
289
-
/**
290
-
* This is a simple enum with strings
291
-
*/
292
-
'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串';
293
-
};
294
-
295
-
/**
296
-
* This is a model with one enum
297
-
*/
298
-
export type ModelWithEnum = {
299
-
/**
300
-
* This is a simple enum with strings
301
-
*/
302
-
'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串';
303
-
/**
304
-
* These are the HTTP error code enums
305
-
*/
306
-
statusCode?: '100' | '200 FOO' | '300 FOO_BAR' | '400 foo-bar' | '500 foo.bar' | '600 foo&bar';
307
-
/**
308
-
* Simple boolean enum
309
-
*/
310
-
bool?: true;
311
-
};
312
-
313
-
/**
314
-
* This is a model with one enum with escaped name
315
-
*/
316
-
export type ModelWithEnumWithHyphen = {
317
-
/**
318
-
* Foo-Bar-Baz-Qux
319
-
*/
320
-
'foo-bar-baz-qux'?: '3.0';
321
-
};
322
-
323
-
/**
324
-
* This is a model with one enum
325
-
*/
326
-
export type ModelWithEnumFromDescription = {
327
-
/**
328
-
* Success=1,Warning=2,Error=3
329
-
*/
330
-
test?: number;
331
-
};
332
-
333
-
/**
334
-
* This is a model with nested enums
335
-
*/
336
-
export type ModelWithNestedEnums = {
337
-
dictionaryWithEnum?: {
338
-
[key: string]: 'Success' | 'Warning' | 'Error';
339
-
};
340
-
dictionaryWithEnumFromDescription?: {
341
-
[key: string]: number;
342
-
};
343
-
arrayWithEnum?: Array<'Success' | 'Warning' | 'Error'>;
344
-
arrayWithDescription?: Array<number>;
345
-
/**
346
-
* This is a simple enum with strings
347
-
*/
348
-
'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串';
349
-
};
350
-
351
-
/**
352
-
* This is a model with one property containing a reference
353
-
*/
354
-
export type ModelWithReference = {
355
-
prop?: ModelWithProperties;
356
-
};
357
-
358
-
/**
359
-
* This is a model with one property containing an array
360
-
*/
361
-
export type ModelWithArrayReadOnlyAndWriteOnly = {
362
-
prop?: Array<ModelWithReadOnlyAndWriteOnly>;
363
-
propWithFile?: Array<Blob | File>;
364
-
propWithNumber?: Array<number>;
365
-
};
366
-
367
-
/**
368
-
* This is a model with one property containing an array
369
-
*/
370
-
export type ModelWithArray = {
371
-
prop?: Array<ModelWithString>;
372
-
propWithFile?: Array<Blob | File>;
373
-
propWithNumber?: Array<number>;
374
-
};
375
-
376
-
/**
377
-
* This is a model with one property containing a dictionary
378
-
*/
379
-
export type ModelWithDictionary = {
380
-
prop?: {
381
-
[key: string]: string;
382
-
};
383
-
};
384
-
385
-
/**
386
-
* This is a deprecated model with a deprecated property
387
-
*
388
-
* @deprecated
389
-
*/
390
-
export type DeprecatedModel = {
391
-
/**
392
-
* This is a deprecated property
393
-
*
394
-
* @deprecated
395
-
*/
396
-
prop?: string;
397
-
};
398
-
399
-
/**
400
-
* This is a model with one property containing a circular reference
401
-
*/
402
-
export type ModelWithCircularReference = {
403
-
prop?: ModelWithCircularReference;
404
-
};
405
-
406
-
/**
407
-
* This is a model with one property with a 'one of' relationship
408
-
*/
409
-
export type CompositionWithOneOf = {
410
-
propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary;
411
-
};
412
-
413
-
/**
414
-
* This is a model with one property with a 'one of' relationship where the options are not $ref
415
-
*/
416
-
export type CompositionWithOneOfAnonymous = {
417
-
propA?: {
418
-
propA?: string;
419
-
} | string | number;
420
-
};
421
-
422
-
/**
423
-
* Circle
424
-
*/
425
-
export type ModelCircle = {
426
-
kind: string;
427
-
radius?: number;
428
-
};
429
-
430
-
/**
431
-
* Square
432
-
*/
433
-
export type ModelSquare = {
434
-
kind: string;
435
-
sideLength?: number;
436
-
};
437
-
438
-
/**
439
-
* This is a model with one property with a 'one of' relationship where the options are not $ref
440
-
*/
441
-
export type CompositionWithOneOfDiscriminator = ({
442
-
kind: 'circle';
443
-
} & ModelCircle) | ({
444
-
kind: 'square';
445
-
} & ModelSquare);
446
-
447
-
/**
448
-
* This is a model with one property with a 'any of' relationship
449
-
*/
450
-
export type CompositionWithAnyOf = {
451
-
propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary;
452
-
};
453
-
454
-
/**
455
-
* This is a model with one property with a 'any of' relationship where the options are not $ref
456
-
*/
457
-
export type CompositionWithAnyOfAnonymous = {
458
-
propA?: {
459
-
propA?: string;
460
-
} | string | number;
461
-
};
462
-
463
-
/**
464
-
* This is a model with nested 'any of' property with a type null
465
-
*/
466
-
export type CompositionWithNestedAnyAndTypeNull = {
467
-
propA?: Array<ModelWithDictionary | null> | Array<ModelWithArray | null>;
468
-
};
469
-
470
-
export type _3eNum1Период = 'Bird' | 'Dog';
471
-
472
-
export type ConstValue = 'ConstValue';
473
-
474
-
/**
475
-
* This is a model with one property with a 'any of' relationship where the options are not $ref
476
-
*/
477
-
export type CompositionWithNestedAnyOfAndNull = {
478
-
propA?: Array<_3eNum1Период | ConstValue> | null;
479
-
};
480
-
481
-
/**
482
-
* This is a model with one property with a 'one of' relationship
483
-
*/
484
-
export type CompositionWithOneOfAndNullable = {
485
-
propA?: {
486
-
boolean?: boolean;
487
-
} | ModelWithEnum | ModelWithArray | ModelWithDictionary | null;
488
-
};
489
-
490
-
/**
491
-
* This is a model that contains a simple dictionary within composition
492
-
*/
493
-
export type CompositionWithOneOfAndSimpleDictionary = {
494
-
propA?: boolean | {
495
-
[key: string]: number;
496
-
};
497
-
};
498
-
499
-
/**
500
-
* This is a model that contains a dictionary of simple arrays within composition
501
-
*/
502
-
export type CompositionWithOneOfAndSimpleArrayDictionary = {
503
-
propA?: boolean | {
504
-
[key: string]: Array<boolean>;
505
-
};
506
-
};
507
-
508
-
/**
509
-
* This is a model that contains a dictionary of complex arrays (composited) within composition
510
-
*/
511
-
export type CompositionWithOneOfAndComplexArrayDictionary = {
512
-
propA?: boolean | {
513
-
[key: string]: Array<number | string>;
514
-
};
515
-
};
516
-
517
-
/**
518
-
* This is a model with one property with a 'all of' relationship
519
-
*/
520
-
export type CompositionWithAllOfAndNullable = {
521
-
propA?: ({
522
-
boolean?: boolean;
523
-
} & ModelWithEnum & ModelWithArray & ModelWithDictionary) | null;
524
-
};
525
-
526
-
/**
527
-
* This is a model with one property with a 'any of' relationship
528
-
*/
529
-
export type CompositionWithAnyOfAndNullable = {
530
-
propA?: {
531
-
boolean?: boolean;
532
-
} | ModelWithEnum | ModelWithArray | ModelWithDictionary | null;
533
-
};
534
-
535
-
/**
536
-
* This is a base model with two simple optional properties
537
-
*/
538
-
export type CompositionBaseModel = {
539
-
firstName?: string;
540
-
lastname?: string;
541
-
};
542
-
543
-
/**
544
-
* This is a model that extends the base model
545
-
*/
546
-
export type CompositionExtendedModel = CompositionBaseModel & {
547
-
age: number;
548
-
firstName: string;
549
-
lastname: string;
550
-
};
551
-
552
-
/**
553
-
* This is a model with one nested property
554
-
*/
555
-
export type ModelWithProperties = {
556
-
required: string;
557
-
readonly requiredAndReadOnly: string;
558
-
requiredAndNullable: string | null;
559
-
string?: string;
560
-
number?: number;
561
-
boolean?: boolean;
562
-
reference?: ModelWithString;
563
-
'property with space'?: string;
564
-
default?: string;
565
-
try?: string;
566
-
readonly '@namespace.string'?: string;
567
-
readonly '@namespace.integer'?: number;
568
-
};
569
-
570
-
/**
571
-
* This is a model with one nested property
572
-
*/
573
-
export type ModelWithNestedProperties = {
574
-
readonly first: {
575
-
readonly second: {
576
-
readonly third: string | null;
577
-
} | null;
578
-
} | null;
579
-
};
580
-
581
-
/**
582
-
* This is a model with duplicated properties
583
-
*/
584
-
export type ModelWithDuplicateProperties = {
585
-
prop?: ModelWithString;
586
-
};
587
-
588
-
/**
589
-
* This is a model with ordered properties
590
-
*/
591
-
export type ModelWithOrderedProperties = {
592
-
zebra?: string;
593
-
apple?: string;
594
-
hawaii?: string;
595
-
};
596
-
597
-
/**
598
-
* This is a model with duplicated imports
599
-
*/
600
-
export type ModelWithDuplicateImports = {
601
-
propA?: ModelWithString;
602
-
propB?: ModelWithString;
603
-
propC?: ModelWithString;
604
-
};
605
-
606
-
/**
607
-
* This is a model that extends another model
608
-
*/
609
-
export type ModelThatExtends = ModelWithString & {
610
-
propExtendsA?: string;
611
-
propExtendsB?: ModelWithString;
612
-
};
613
-
614
-
/**
615
-
* This is a model that extends another model
616
-
*/
617
-
export type ModelThatExtendsExtends = ModelWithString & ModelThatExtends & {
618
-
propExtendsC?: string;
619
-
propExtendsD?: ModelWithString;
620
-
};
621
-
622
-
/**
623
-
* This is a model that contains a some patterns
624
-
*/
625
-
export type ModelWithPattern = {
626
-
key: string;
627
-
name: string;
628
-
readonly enabled?: boolean;
629
-
readonly modified?: string;
630
-
id?: string;
631
-
text?: string;
632
-
patternWithSingleQuotes?: string;
633
-
patternWithNewline?: string;
634
-
patternWithBacktick?: string;
635
-
};
636
-
637
-
export type File = {
638
-
/**
639
-
* Id
640
-
*/
641
-
readonly id?: string;
642
-
/**
643
-
* Updated at
644
-
*/
645
-
readonly updated_at?: string;
646
-
/**
647
-
* Created at
648
-
*/
649
-
readonly created_at?: string;
650
-
/**
651
-
* Mime
652
-
*/
653
-
mime: string;
654
-
/**
655
-
* File
656
-
*/
657
-
readonly file?: string;
658
-
};
659
-
660
-
export type Default = {
661
-
name?: string;
662
-
};
663
-
664
-
export type Pageable = {
665
-
page?: number;
666
-
size?: number;
667
-
sort?: Array<string>;
668
-
};
669
-
670
-
/**
671
-
* This is a free-form object without additionalProperties.
672
-
*/
673
-
export type FreeFormObjectWithoutAdditionalProperties = {
674
-
[key: string]: unknown;
675
-
};
676
-
677
-
/**
678
-
* This is a free-form object with additionalProperties: true.
679
-
*/
680
-
export type FreeFormObjectWithAdditionalPropertiesEqTrue = {
681
-
[key: string]: unknown;
682
-
};
683
-
684
-
/**
685
-
* This is a free-form object with additionalProperties: {}.
686
-
*/
687
-
export type FreeFormObjectWithAdditionalPropertiesEqEmptyObject = {
688
-
[key: string]: unknown;
689
-
};
690
-
691
-
export type ModelWithConst = {
692
-
String?: 'String';
693
-
number?: 0;
694
-
null?: unknown;
695
-
withType?: 'Some string';
696
-
};
697
-
698
-
/**
699
-
* This is a model with one property and additionalProperties: true
700
-
*/
701
-
export type ModelWithAdditionalPropertiesEqTrue = {
702
-
/**
703
-
* This is a simple string property
704
-
*/
705
-
prop?: string;
706
-
[key: string]: unknown | string | undefined;
707
-
};
708
-
709
-
export type NestedAnyOfArraysNullable = {
710
-
nullableArray?: Array<string | boolean> | null;
711
-
};
712
-
713
-
export type CompositionWithOneOfAndProperties = ({
714
-
foo: SimpleParameter;
715
-
} | {
716
-
bar: NonAsciiStringæøåÆøÅöôêÊ字符串;
717
-
}) & {
718
-
baz: number | null;
719
-
qux: number;
720
-
};
721
-
722
-
/**
723
-
* An object that can be null
724
-
*/
725
-
export type NullableObject = {
726
-
foo?: string;
727
-
} | null;
728
-
729
-
/**
730
-
* Some % character
731
-
*/
732
-
export type CharactersInDescription = string;
733
-
734
-
export type ModelWithNullableObject = {
735
-
data?: NullableObject;
736
-
};
737
-
738
-
export type ModelWithOneOfEnum = {
739
-
foo: 'Bar';
740
-
} | {
741
-
foo: 'Baz';
742
-
} | {
743
-
foo: 'Qux';
744
-
} | {
745
-
content: string;
746
-
foo: 'Quux';
747
-
} | {
748
-
content: [
749
-
string,
750
-
string
751
-
];
752
-
foo: 'Corge';
753
-
};
754
-
755
-
export type ModelWithNestedArrayEnumsDataFoo = 'foo' | 'bar';
756
-
757
-
export type ModelWithNestedArrayEnumsDataBar = 'baz' | 'qux';
758
-
759
-
export type ModelWithNestedArrayEnumsData = {
760
-
foo?: Array<ModelWithNestedArrayEnumsDataFoo>;
761
-
bar?: Array<ModelWithNestedArrayEnumsDataBar>;
762
-
};
763
-
764
-
export type ModelWithNestedArrayEnums = {
765
-
array_strings?: Array<string>;
766
-
data?: ModelWithNestedArrayEnumsData;
767
-
};
768
-
769
-
export type ModelWithNestedCompositionEnums = {
770
-
foo?: ModelWithNestedArrayEnumsDataFoo;
771
-
};
772
-
773
-
export type ModelWithReadOnlyAndWriteOnly = {
774
-
foo: string;
775
-
readonly bar: string;
776
-
};
777
-
778
-
export type ModelWithConstantSizeArray = [
779
-
number,
780
-
number
781
-
];
782
-
783
-
export type ModelWithAnyOfConstantSizeArray = [
784
-
number | string,
785
-
number | string,
786
-
number | string
787
-
];
788
-
789
-
export type ModelWithPrefixItemsConstantSizeArray = Array<ModelWithInteger | number | string>;
790
-
791
-
export type ModelWithAnyOfConstantSizeArrayNullable = [
792
-
number | null | string,
793
-
number | null | string,
794
-
number | null | string
795
-
];
796
-
797
-
export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions = [
798
-
number | Import,
799
-
number | Import
800
-
];
801
-
802
-
export type ModelWithAnyOfConstantSizeArrayAndIntersect = [
803
-
number & string,
804
-
number & string
805
-
];
806
-
807
-
export type ModelWithNumericEnumUnion = {
808
-
/**
809
-
* Период
810
-
*/
811
-
value?: -10 | -1 | 0 | 1 | 3 | 6 | 12;
812
-
};
813
-
814
-
/**
815
-
* Some description with `back ticks`
816
-
*/
817
-
export type ModelWithBackticksInDescription = {
818
-
/**
819
-
* The template `that` should be used for parsing and importing the contents of the CSV file.
820
-
*
821
-
* <br/><p>There is one placeholder currently supported:<ul> <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct JSON template:</p>
822
-
* <pre>
823
-
* [
824
-
* {
825
-
* "resourceType": "Asset",
826
-
* "identifier": {
827
-
* "name": "${1}",
828
-
* "domain": {
829
-
* "name": "${2}",
830
-
* "community": {
831
-
* "name": "Some Community"
832
-
* }
833
-
* }
834
-
* },
835
-
* "attributes" : {
836
-
* "00000000-0000-0000-0000-000000003115" : [ {
837
-
* "value" : "${3}"
838
-
* } ],
839
-
* "00000000-0000-0000-0000-000000000222" : [ {
840
-
* "value" : "${4}"
841
-
* } ]
842
-
* }
843
-
* }
844
-
* ]
845
-
* </pre>
846
-
*/
847
-
template?: string;
848
-
};
849
-
850
-
export type ModelWithOneOfAndProperties = (SimpleParameter | NonAsciiStringæøåÆøÅöôêÊ字符串) & {
851
-
baz: number | null;
852
-
qux: number;
853
-
};
854
-
855
-
/**
856
-
* Model used to test deduplication strategy (unused)
857
-
*/
858
-
export type ParameterSimpleParameterUnused = string;
859
-
860
-
/**
861
-
* Model used to test deduplication strategy
862
-
*/
863
-
export type PostServiceWithEmptyTagResponse = string;
864
-
865
-
/**
866
-
* Model used to test deduplication strategy
867
-
*/
868
-
export type PostServiceWithEmptyTagResponse2 = string;
869
-
870
-
/**
871
-
* Model used to test deduplication strategy
872
-
*/
873
-
export type DeleteFooData = string;
874
-
875
-
/**
876
-
* Model used to test deduplication strategy
877
-
*/
878
-
export type DeleteFooData2 = string;
879
-
880
-
/**
881
-
* Model with restricted keyword name
882
-
*/
883
-
export type Import = string;
884
-
885
-
export type SchemaWithFormRestrictedKeys = {
886
-
description?: string;
887
-
'x-enum-descriptions'?: string;
888
-
'x-enum-varnames'?: string;
889
-
'x-enumNames'?: string;
890
-
title?: string;
891
-
object?: {
892
-
description?: string;
893
-
'x-enum-descriptions'?: string;
894
-
'x-enum-varnames'?: string;
895
-
'x-enumNames'?: string;
896
-
title?: string;
897
-
};
898
-
array?: Array<{
899
-
description?: string;
900
-
'x-enum-descriptions'?: string;
901
-
'x-enum-varnames'?: string;
902
-
'x-enumNames'?: string;
903
-
title?: string;
904
-
}>;
905
-
};
906
-
907
-
/**
908
-
* This schema was giving PascalCase transformations a hard time
909
-
*/
910
-
export type IoK8sApimachineryPkgApisMetaV1DeleteOptions = {
911
-
/**
912
-
* Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
913
-
*/
914
-
preconditions?: IoK8sApimachineryPkgApisMetaV1Preconditions;
915
-
};
916
-
917
-
/**
918
-
* This schema was giving PascalCase transformations a hard time
919
-
*/
920
-
export type IoK8sApimachineryPkgApisMetaV1Preconditions = {
921
-
/**
922
-
* Specifies the target ResourceVersion
923
-
*/
924
-
resourceVersion?: string;
925
-
/**
926
-
* Specifies the target UID.
927
-
*/
928
-
uid?: string;
929
-
};
930
-
931
-
export type AdditionalPropertiesUnknownIssue = {
932
-
[key: string]: string | number;
933
-
};
934
-
935
-
export type AdditionalPropertiesUnknownIssue2 = {
936
-
[key: string]: string | number;
937
-
};
938
-
939
-
export type AdditionalPropertiesUnknownIssue3 = string & {
940
-
entries: {
941
-
[key: string]: AdditionalPropertiesUnknownIssue;
942
-
};
943
-
};
944
-
945
-
export type AdditionalPropertiesIntegerIssue = {
946
-
value: number;
947
-
[key: string]: number;
948
-
};
949
-
950
-
export type OneOfAllOfIssue = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString;
951
-
952
-
export type GenericSchemaDuplicateIssue1SystemBoolean = {
953
-
item?: boolean;
954
-
error?: string | null;
955
-
readonly hasError?: boolean;
956
-
data?: {
957
-
[key: string]: never;
958
-
};
959
-
};
960
-
961
-
export type GenericSchemaDuplicateIssue1SystemString = {
962
-
item?: string | null;
963
-
error?: string | null;
964
-
readonly hasError?: boolean;
965
-
};
966
-
967
-
export type ExternalSharedExternalSharedModel = {
968
-
id: string;
969
-
name?: string;
970
-
};
971
-
972
-
/**
973
-
* This is a model with one property containing a reference
974
-
*/
975
-
export type ModelWithReferenceWritable = {
976
-
prop?: ModelWithPropertiesWritable;
977
-
};
978
-
979
-
/**
980
-
* This is a model with one property containing an array
981
-
*/
982
-
export type ModelWithArrayReadOnlyAndWriteOnlyWritable = {
983
-
prop?: Array<ModelWithReadOnlyAndWriteOnlyWritable>;
984
-
propWithFile?: Array<Blob | File>;
985
-
propWithNumber?: Array<number>;
986
-
};
987
-
988
-
/**
989
-
* This is a model with one nested property
990
-
*/
991
-
export type ModelWithPropertiesWritable = {
992
-
required: string;
993
-
requiredAndNullable: string | null;
994
-
string?: string;
995
-
number?: number;
996
-
boolean?: boolean;
997
-
reference?: ModelWithString;
998
-
'property with space'?: string;
999
-
default?: string;
1000
-
try?: string;
1001
-
};
1002
-
1003
-
/**
1004
-
* This is a model that contains a some patterns
1005
-
*/
1006
-
export type ModelWithPatternWritable = {
1007
-
key: string;
1008
-
name: string;
1009
-
id?: string;
1010
-
text?: string;
1011
-
patternWithSingleQuotes?: string;
1012
-
patternWithNewline?: string;
1013
-
patternWithBacktick?: string;
1014
-
};
1015
-
1016
-
export type FileWritable = {
1017
-
/**
1018
-
* Mime
1019
-
*/
1020
-
mime: string;
1021
-
};
1022
-
1023
-
export type ModelWithReadOnlyAndWriteOnlyWritable = {
1024
-
foo: string;
1025
-
baz: string;
1026
-
};
1027
-
1028
-
export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable = [
1029
-
number | Import,
1030
-
number | Import
1031
-
];
1032
-
1033
-
export type AdditionalPropertiesUnknownIssueWritable = {
1034
-
[key: string]: string | number;
1035
-
};
1036
-
1037
-
export type OneOfAllOfIssueWritable = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString;
1038
-
1039
-
export type GenericSchemaDuplicateIssue1SystemBooleanWritable = {
1040
-
item?: boolean;
1041
-
error?: string | null;
1042
-
data?: {
1043
-
[key: string]: never;
1044
-
};
1045
-
};
1046
-
1047
-
export type GenericSchemaDuplicateIssue1SystemStringWritable = {
1048
-
item?: string | null;
1049
-
error?: string | null;
1050
-
};
1051
-
1052
-
/**
1053
-
* This is a reusable parameter
1054
-
*/
1055
-
export type SimpleParameter = string;
1056
-
1057
-
/**
1058
-
* Parameter with illegal characters
1059
-
*/
1060
-
export type XFooBar = ModelWithString;
1061
-
1062
-
export type SimpleRequestBody = ModelWithString;
1063
-
1064
-
export type SimpleFormData = ModelWithString;
1065
-
1066
-
export type ExportData = {
1067
-
body?: never;
1068
-
path?: never;
1069
-
query?: never;
1070
-
url: '/api/v{api-version}/no+tag';
1071
-
};
1072
-
1073
-
export type PatchApiVbyApiVersionNoTagData = {
1074
-
body?: never;
1075
-
path?: never;
1076
-
query?: never;
1077
-
url: '/api/v{api-version}/no+tag';
1078
-
};
1079
-
1080
-
export type PatchApiVbyApiVersionNoTagResponses = {
1081
-
/**
1082
-
* OK
1083
-
*/
1084
-
default: unknown;
1085
-
};
1086
-
1087
-
export type ImportData = {
1088
-
body: ModelWithReadOnlyAndWriteOnlyWritable | ModelWithArrayReadOnlyAndWriteOnlyWritable;
1089
-
path?: never;
1090
-
query?: never;
1091
-
url: '/api/v{api-version}/no+tag';
1092
-
};
1093
-
1094
-
export type ImportResponses = {
1095
-
/**
1096
-
* Success
1097
-
*/
1098
-
200: ModelFromZendesk;
1099
-
/**
1100
-
* Default success response
1101
-
*/
1102
-
default: ModelWithReadOnlyAndWriteOnly;
1103
-
};
1104
-
1105
-
export type ImportResponse = ImportResponses[keyof ImportResponses];
1106
-
1107
-
export type FooWowData = {
1108
-
body?: never;
1109
-
path?: never;
1110
-
query?: never;
1111
-
url: '/api/v{api-version}/no+tag';
1112
-
};
1113
-
1114
-
export type FooWowResponses = {
1115
-
/**
1116
-
* OK
1117
-
*/
1118
-
default: unknown;
1119
-
};
1120
-
1121
-
export type ApiVVersionODataControllerCountData = {
1122
-
body?: never;
1123
-
path?: never;
1124
-
query?: never;
1125
-
url: '/api/v{api-version}/simple/$count';
1126
-
};
1127
-
1128
-
export type ApiVVersionODataControllerCountResponses = {
1129
-
/**
1130
-
* Success
1131
-
*/
1132
-
200: ModelFromZendesk;
1133
-
};
1134
-
1135
-
export type ApiVVersionODataControllerCountResponse = ApiVVersionODataControllerCountResponses[keyof ApiVVersionODataControllerCountResponses];
1136
-
1137
-
export type GetApiVbyApiVersionSimpleOperationData = {
1138
-
body?: never;
1139
-
path: {
1140
-
/**
1141
-
* foo in method
1142
-
*/
1143
-
foo_param: string;
1144
-
};
1145
-
query?: never;
1146
-
url: '/api/v{api-version}/simple:operation';
1147
-
};
1148
-
1149
-
export type GetApiVbyApiVersionSimpleOperationErrors = {
1150
-
/**
1151
-
* Default error response
1152
-
*/
1153
-
default: ModelWithBoolean;
1154
-
};
1155
-
1156
-
export type GetApiVbyApiVersionSimpleOperationError = GetApiVbyApiVersionSimpleOperationErrors[keyof GetApiVbyApiVersionSimpleOperationErrors];
1157
-
1158
-
export type GetApiVbyApiVersionSimpleOperationResponses = {
1159
-
/**
1160
-
* Response is a simple number
1161
-
*/
1162
-
200: number;
1163
-
};
1164
-
1165
-
export type GetApiVbyApiVersionSimpleOperationResponse = GetApiVbyApiVersionSimpleOperationResponses[keyof GetApiVbyApiVersionSimpleOperationResponses];
1166
-
1167
-
export type DeleteCallWithoutParametersAndResponseData = {
1168
-
body?: never;
1169
-
path?: never;
1170
-
query?: never;
1171
-
url: '/api/v{api-version}/simple';
1172
-
};
1173
-
1174
-
export type GetCallWithoutParametersAndResponseData = {
1175
-
body?: never;
1176
-
path?: never;
1177
-
query?: never;
1178
-
url: '/api/v{api-version}/simple';
1179
-
};
1180
-
1181
-
export type HeadCallWithoutParametersAndResponseData = {
1182
-
body?: never;
1183
-
path?: never;
1184
-
query?: never;
1185
-
url: '/api/v{api-version}/simple';
1186
-
};
1187
-
1188
-
export type OptionsCallWithoutParametersAndResponseData = {
1189
-
body?: never;
1190
-
path?: never;
1191
-
query?: never;
1192
-
url: '/api/v{api-version}/simple';
1193
-
};
1194
-
1195
-
export type PatchCallWithoutParametersAndResponseData = {
1196
-
body?: never;
1197
-
path?: never;
1198
-
query?: never;
1199
-
url: '/api/v{api-version}/simple';
1200
-
};
1201
-
1202
-
export type PostCallWithoutParametersAndResponseData = {
1203
-
body?: never;
1204
-
path?: never;
1205
-
query?: never;
1206
-
url: '/api/v{api-version}/simple';
1207
-
};
1208
-
1209
-
export type PutCallWithoutParametersAndResponseData = {
1210
-
body?: never;
1211
-
path?: never;
1212
-
query?: never;
1213
-
url: '/api/v{api-version}/simple';
1214
-
};
1215
-
1216
-
export type DeleteFooData3 = {
1217
-
body?: never;
1218
-
headers: {
1219
-
/**
1220
-
* Parameter with illegal characters
1221
-
*/
1222
-
'x-Foo-Bar': ModelWithString;
1223
-
};
1224
-
path: {
1225
-
/**
1226
-
* foo in method
1227
-
*/
1228
-
foo_param: string;
1229
-
/**
1230
-
* bar in method
1231
-
*/
1232
-
BarParam: string;
1233
-
};
1234
-
query?: never;
1235
-
url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}';
1236
-
};
1237
-
1238
-
export type CallWithDescriptionsData = {
1239
-
body?: never;
1240
-
path?: never;
1241
-
query?: {
1242
-
/**
1243
-
* Testing multiline comments in string: First line
1244
-
* Second line
1245
-
*
1246
-
* Fourth line
1247
-
*/
1248
-
parameterWithBreaks?: string;
1249
-
/**
1250
-
* Testing backticks in string: `backticks` and ```multiple backticks``` should work
1251
-
*/
1252
-
parameterWithBackticks?: string;
1253
-
/**
1254
-
* Testing slashes in string: \backwards\\\ and /forwards/// should work
1255
-
*/
1256
-
parameterWithSlashes?: string;
1257
-
/**
1258
-
* Testing expression placeholders in string: ${expression} should work
1259
-
*/
1260
-
parameterWithExpressionPlaceholders?: string;
1261
-
/**
1262
-
* Testing quotes in string: 'single quote''' and "double quotes""" should work
1263
-
*/
1264
-
parameterWithQuotes?: string;
1265
-
/**
1266
-
* Testing reserved characters in string: * inline * and ** inline ** should work
1267
-
*/
1268
-
parameterWithReservedCharacters?: string;
1269
-
};
1270
-
url: '/api/v{api-version}/descriptions';
1271
-
};
1272
-
1273
-
export type DeprecatedCallData = {
1274
-
body?: never;
1275
-
headers: {
1276
-
/**
1277
-
* This parameter is deprecated
1278
-
*
1279
-
* @deprecated
1280
-
*/
1281
-
parameter: DeprecatedModel | null;
1282
-
};
1283
-
path?: never;
1284
-
query?: never;
1285
-
url: '/api/v{api-version}/parameters/deprecated';
1286
-
};
1287
-
1288
-
export type CallWithParametersData = {
1289
-
/**
1290
-
* This is the parameter that goes into the body
1291
-
*/
1292
-
body: {
1293
-
[key: string]: unknown;
1294
-
} | null;
1295
-
headers: {
1296
-
/**
1297
-
* This is the parameter that goes into the header
1298
-
*/
1299
-
parameterHeader: string | null;
1300
-
};
1301
-
path: {
1302
-
/**
1303
-
* This is the parameter that goes into the path
1304
-
*/
1305
-
parameterPath: string | null;
1306
-
/**
1307
-
* api-version should be required in standalone clients
1308
-
*/
1309
-
'api-version': string | null;
1310
-
};
1311
-
query: {
1312
-
foo_ref_enum?: ModelWithNestedArrayEnumsDataFoo;
1313
-
foo_all_of_enum: ModelWithNestedArrayEnumsDataFoo;
1314
-
/**
1315
-
* This is the parameter that goes into the query params
1316
-
*/
1317
-
cursor: string | null;
1318
-
};
1319
-
url: '/api/v{api-version}/parameters/{parameterPath}';
1320
-
};
1321
-
1322
-
export type CallWithWeirdParameterNamesData = {
1323
-
/**
1324
-
* This is the parameter that goes into the body
1325
-
*/
1326
-
body: ModelWithString | null;
1327
-
headers: {
1328
-
/**
1329
-
* This is the parameter that goes into the request header
1330
-
*/
1331
-
'parameter.header': string | null;
1332
-
};
1333
-
path: {
1334
-
/**
1335
-
* This is the parameter that goes into the path
1336
-
*/
1337
-
'parameter.path.1'?: string;
1338
-
/**
1339
-
* This is the parameter that goes into the path
1340
-
*/
1341
-
'parameter-path-2'?: string;
1342
-
/**
1343
-
* This is the parameter that goes into the path
1344
-
*/
1345
-
'PARAMETER-PATH-3'?: string;
1346
-
/**
1347
-
* api-version should be required in standalone clients
1348
-
*/
1349
-
'api-version': string | null;
1350
-
};
1351
-
query: {
1352
-
/**
1353
-
* This is the parameter with a reserved keyword
1354
-
*/
1355
-
default?: string;
1356
-
/**
1357
-
* This is the parameter that goes into the request query params
1358
-
*/
1359
-
'parameter-query': string | null;
1360
-
};
1361
-
url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}';
1362
-
};
1363
-
1364
-
export type GetCallWithOptionalParamData = {
1365
-
/**
1366
-
* This is a required parameter
1367
-
*/
1368
-
body: ModelWithOneOfEnum;
1369
-
path?: never;
1370
-
query?: {
1371
-
/**
1372
-
* This is an optional parameter
1373
-
*/
1374
-
page?: number;
1375
-
};
1376
-
url: '/api/v{api-version}/parameters';
1377
-
};
1378
-
1379
-
export type PostCallWithOptionalParamData = {
1380
-
/**
1381
-
* This is an optional parameter
1382
-
*/
1383
-
body?: {
1384
-
offset?: number | null;
1385
-
};
1386
-
path?: never;
1387
-
query: {
1388
-
/**
1389
-
* This is a required parameter
1390
-
*/
1391
-
parameter: Pageable;
1392
-
};
1393
-
url: '/api/v{api-version}/parameters';
1394
-
};
1395
-
1396
-
export type PostCallWithOptionalParamResponses = {
1397
-
/**
1398
-
* Response is a simple number
1399
-
*/
1400
-
200: number;
1401
-
/**
1402
-
* Success
1403
-
*/
1404
-
204: void;
1405
-
};
1406
-
1407
-
export type PostCallWithOptionalParamResponse = PostCallWithOptionalParamResponses[keyof PostCallWithOptionalParamResponses];
1408
-
1409
-
export type PostApiVbyApiVersionRequestBodyData = {
1410
-
/**
1411
-
* A reusable request body
1412
-
*/
1413
-
body?: SimpleRequestBody;
1414
-
path?: never;
1415
-
query?: {
1416
-
/**
1417
-
* This is a reusable parameter
1418
-
*/
1419
-
parameter?: string;
1420
-
};
1421
-
url: '/api/v{api-version}/requestBody';
1422
-
};
1423
-
1424
-
export type PostApiVbyApiVersionFormDataData = {
1425
-
/**
1426
-
* A reusable request body
1427
-
*/
1428
-
body?: SimpleFormData;
1429
-
path?: never;
1430
-
query?: {
1431
-
/**
1432
-
* This is a reusable parameter
1433
-
*/
1434
-
parameter?: string;
1435
-
};
1436
-
url: '/api/v{api-version}/formData';
1437
-
};
1438
-
1439
-
export type CallWithDefaultParametersData = {
1440
-
body?: never;
1441
-
path?: never;
1442
-
query?: {
1443
-
/**
1444
-
* This is a simple string with default value
1445
-
*/
1446
-
parameterString?: string | null;
1447
-
/**
1448
-
* This is a simple number with default value
1449
-
*/
1450
-
parameterNumber?: number | null;
1451
-
/**
1452
-
* This is a simple boolean with default value
1453
-
*/
1454
-
parameterBoolean?: boolean | null;
1455
-
/**
1456
-
* This is a simple enum with default value
1457
-
*/
1458
-
parameterEnum?: 'Success' | 'Warning' | 'Error';
1459
-
/**
1460
-
* This is a simple model with default value
1461
-
*/
1462
-
parameterModel?: ModelWithString | null;
1463
-
};
1464
-
url: '/api/v{api-version}/defaults';
1465
-
};
1466
-
1467
-
export type CallWithDefaultOptionalParametersData = {
1468
-
body?: never;
1469
-
path?: never;
1470
-
query?: {
1471
-
/**
1472
-
* This is a simple string that is optional with default value
1473
-
*/
1474
-
parameterString?: string;
1475
-
/**
1476
-
* This is a simple number that is optional with default value
1477
-
*/
1478
-
parameterNumber?: number;
1479
-
/**
1480
-
* This is a simple boolean that is optional with default value
1481
-
*/
1482
-
parameterBoolean?: boolean;
1483
-
/**
1484
-
* This is a simple enum that is optional with default value
1485
-
*/
1486
-
parameterEnum?: 'Success' | 'Warning' | 'Error';
1487
-
/**
1488
-
* This is a simple model that is optional with default value
1489
-
*/
1490
-
parameterModel?: ModelWithString;
1491
-
};
1492
-
url: '/api/v{api-version}/defaults';
1493
-
};
1494
-
1495
-
export type CallToTestOrderOfParamsData = {
1496
-
body?: never;
1497
-
path?: never;
1498
-
query: {
1499
-
/**
1500
-
* This is a optional string with default
1501
-
*/
1502
-
parameterOptionalStringWithDefault?: string;
1503
-
/**
1504
-
* This is a optional string with empty default
1505
-
*/
1506
-
parameterOptionalStringWithEmptyDefault?: string;
1507
-
/**
1508
-
* This is a optional string with no default
1509
-
*/
1510
-
parameterOptionalStringWithNoDefault?: string;
1511
-
/**
1512
-
* This is a string with default
1513
-
*/
1514
-
parameterStringWithDefault: string;
1515
-
/**
1516
-
* This is a string with empty default
1517
-
*/
1518
-
parameterStringWithEmptyDefault: string;
1519
-
/**
1520
-
* This is a string with no default
1521
-
*/
1522
-
parameterStringWithNoDefault: string;
1523
-
/**
1524
-
* This is a string that can be null with no default
1525
-
*/
1526
-
parameterStringNullableWithNoDefault?: string | null;
1527
-
/**
1528
-
* This is a string that can be null with default
1529
-
*/
1530
-
parameterStringNullableWithDefault?: string | null;
1531
-
};
1532
-
url: '/api/v{api-version}/defaults';
1533
-
};
1534
-
1535
-
export type DuplicateNameData = {
1536
-
body?: never;
1537
-
path?: never;
1538
-
query?: never;
1539
-
url: '/api/v{api-version}/duplicate';
1540
-
};
1541
-
1542
-
export type DuplicateName2Data = {
1543
-
body?: never;
1544
-
path?: never;
1545
-
query?: never;
1546
-
url: '/api/v{api-version}/duplicate';
1547
-
};
1548
-
1549
-
export type DuplicateName3Data = {
1550
-
body?: never;
1551
-
path?: never;
1552
-
query?: never;
1553
-
url: '/api/v{api-version}/duplicate';
1554
-
};
1555
-
1556
-
export type DuplicateName4Data = {
1557
-
body?: never;
1558
-
path?: never;
1559
-
query?: never;
1560
-
url: '/api/v{api-version}/duplicate';
1561
-
};
1562
-
1563
-
export type CallWithNoContentResponseData = {
1564
-
body?: never;
1565
-
path?: never;
1566
-
query?: never;
1567
-
url: '/api/v{api-version}/no-content';
1568
-
};
1569
-
1570
-
export type CallWithNoContentResponseResponses = {
1571
-
/**
1572
-
* Success
1573
-
*/
1574
-
204: void;
1575
-
};
1576
-
1577
-
export type CallWithNoContentResponseResponse = CallWithNoContentResponseResponses[keyof CallWithNoContentResponseResponses];
1578
-
1579
-
export type CallWithResponseAndNoContentResponseData = {
1580
-
body?: never;
1581
-
path?: never;
1582
-
query?: never;
1583
-
url: '/api/v{api-version}/multiple-tags/response-and-no-content';
1584
-
};
1585
-
1586
-
export type CallWithResponseAndNoContentResponseResponses = {
1587
-
/**
1588
-
* Response is a simple number
1589
-
*/
1590
-
200: number;
1591
-
/**
1592
-
* Success
1593
-
*/
1594
-
204: void;
1595
-
};
1596
-
1597
-
export type CallWithResponseAndNoContentResponseResponse = CallWithResponseAndNoContentResponseResponses[keyof CallWithResponseAndNoContentResponseResponses];
1598
-
1599
-
export type DummyAData = {
1600
-
body?: never;
1601
-
path?: never;
1602
-
query?: never;
1603
-
url: '/api/v{api-version}/multiple-tags/a';
1604
-
};
1605
-
1606
-
export type DummyAResponses = {
1607
-
200: _400;
1608
-
};
1609
-
1610
-
export type DummyAResponse = DummyAResponses[keyof DummyAResponses];
1611
-
1612
-
export type DummyBData = {
1613
-
body?: never;
1614
-
path?: never;
1615
-
query?: never;
1616
-
url: '/api/v{api-version}/multiple-tags/b';
1617
-
};
1618
-
1619
-
export type DummyBResponses = {
1620
-
/**
1621
-
* Success
1622
-
*/
1623
-
204: void;
1624
-
};
1625
-
1626
-
export type DummyBResponse = DummyBResponses[keyof DummyBResponses];
1627
-
1628
-
export type CallWithResponseData = {
1629
-
body?: never;
1630
-
path?: never;
1631
-
query?: never;
1632
-
url: '/api/v{api-version}/response';
1633
-
};
1634
-
1635
-
export type CallWithResponseResponses = {
1636
-
default: Import;
1637
-
};
1638
-
1639
-
export type CallWithResponseResponse = CallWithResponseResponses[keyof CallWithResponseResponses];
1640
-
1641
-
export type CallWithDuplicateResponsesData = {
1642
-
body?: never;
1643
-
path?: never;
1644
-
query?: never;
1645
-
url: '/api/v{api-version}/response';
1646
-
};
1647
-
1648
-
export type CallWithDuplicateResponsesErrors = {
1649
-
/**
1650
-
* Message for 500 error
1651
-
*/
1652
-
500: ModelWithStringError;
1653
-
/**
1654
-
* Message for 501 error
1655
-
*/
1656
-
501: ModelWithStringError;
1657
-
/**
1658
-
* Message for 502 error
1659
-
*/
1660
-
502: ModelWithStringError;
1661
-
/**
1662
-
* Message for 4XX errors
1663
-
*/
1664
-
'4XX': DictionaryWithArray;
1665
-
/**
1666
-
* Default error response
1667
-
*/
1668
-
default: ModelWithBoolean;
1669
-
};
1670
-
1671
-
export type CallWithDuplicateResponsesError = CallWithDuplicateResponsesErrors[keyof CallWithDuplicateResponsesErrors];
1672
-
1673
-
export type CallWithDuplicateResponsesResponses = {
1674
-
/**
1675
-
* Message for 200 response
1676
-
*/
1677
-
200: ModelWithBoolean & ModelWithInteger;
1678
-
/**
1679
-
* Message for 201 response
1680
-
*/
1681
-
201: ModelWithString;
1682
-
/**
1683
-
* Message for 202 response
1684
-
*/
1685
-
202: ModelWithString;
1686
-
};
1687
-
1688
-
export type CallWithDuplicateResponsesResponse = CallWithDuplicateResponsesResponses[keyof CallWithDuplicateResponsesResponses];
1689
-
1690
-
export type CallWithResponsesData = {
1691
-
body?: never;
1692
-
path?: never;
1693
-
query?: never;
1694
-
url: '/api/v{api-version}/response';
1695
-
};
1696
-
1697
-
export type CallWithResponsesErrors = {
1698
-
/**
1699
-
* Message for 500 error
1700
-
*/
1701
-
500: ModelWithStringError;
1702
-
/**
1703
-
* Message for 501 error
1704
-
*/
1705
-
501: ModelWithStringError;
1706
-
/**
1707
-
* Message for 502 error
1708
-
*/
1709
-
502: ModelWithStringError;
1710
-
/**
1711
-
* Message for default response
1712
-
*/
1713
-
default: ModelWithStringError;
1714
-
};
1715
-
1716
-
export type CallWithResponsesError = CallWithResponsesErrors[keyof CallWithResponsesErrors];
1717
-
1718
-
export type CallWithResponsesResponses = {
1719
-
/**
1720
-
* Message for 200 response
1721
-
*/
1722
-
200: {
1723
-
readonly '@namespace.string'?: string;
1724
-
readonly '@namespace.integer'?: number;
1725
-
readonly value?: Array<ModelWithString>;
1726
-
};
1727
-
/**
1728
-
* Message for 201 response
1729
-
*/
1730
-
201: ModelThatExtends;
1731
-
/**
1732
-
* Message for 202 response
1733
-
*/
1734
-
202: ModelThatExtendsExtends;
1735
-
};
1736
-
1737
-
export type CallWithResponsesResponse = CallWithResponsesResponses[keyof CallWithResponsesResponses];
1738
-
1739
-
export type CollectionFormatData = {
1740
-
body?: never;
1741
-
path?: never;
1742
-
query: {
1743
-
/**
1744
-
* This is an array parameter that is sent as csv format (comma-separated values)
1745
-
*/
1746
-
parameterArrayCSV: Array<string> | null;
1747
-
/**
1748
-
* This is an array parameter that is sent as ssv format (space-separated values)
1749
-
*/
1750
-
parameterArraySSV: Array<string> | null;
1751
-
/**
1752
-
* This is an array parameter that is sent as tsv format (tab-separated values)
1753
-
*/
1754
-
parameterArrayTSV: Array<string> | null;
1755
-
/**
1756
-
* This is an array parameter that is sent as pipes format (pipe-separated values)
1757
-
*/
1758
-
parameterArrayPipes: Array<string> | null;
1759
-
/**
1760
-
* This is an array parameter that is sent as multi format (multiple parameter instances)
1761
-
*/
1762
-
parameterArrayMulti: Array<string> | null;
1763
-
};
1764
-
url: '/api/v{api-version}/collectionFormat';
1765
-
};
1766
-
1767
-
export type TypesData = {
1768
-
body?: never;
1769
-
path?: {
1770
-
/**
1771
-
* This is a number parameter
1772
-
*/
1773
-
id?: number;
1774
-
};
1775
-
query: {
1776
-
/**
1777
-
* This is a number parameter
1778
-
*/
1779
-
parameterNumber: number;
1780
-
/**
1781
-
* This is a string parameter
1782
-
*/
1783
-
parameterString: string | null;
1784
-
/**
1785
-
* This is a boolean parameter
1786
-
*/
1787
-
parameterBoolean: boolean | null;
1788
-
/**
1789
-
* This is an object parameter
1790
-
*/
1791
-
parameterObject: {
1792
-
[key: string]: unknown;
1793
-
} | null;
1794
-
/**
1795
-
* This is an array parameter
1796
-
*/
1797
-
parameterArray: Array<string> | null;
1798
-
/**
1799
-
* This is a dictionary parameter
1800
-
*/
1801
-
parameterDictionary: {
1802
-
[key: string]: unknown;
1803
-
} | null;
1804
-
/**
1805
-
* This is an enum parameter
1806
-
*/
1807
-
parameterEnum: 'Success' | 'Warning' | 'Error';
1808
-
};
1809
-
url: '/api/v{api-version}/types';
1810
-
};
1811
-
1812
-
export type TypesResponses = {
1813
-
/**
1814
-
* Response is a simple number
1815
-
*/
1816
-
200: number;
1817
-
/**
1818
-
* Response is a simple string
1819
-
*/
1820
-
201: string;
1821
-
/**
1822
-
* Response is a simple boolean
1823
-
*/
1824
-
202: boolean;
1825
-
/**
1826
-
* Response is a simple object
1827
-
*/
1828
-
203: {
1829
-
[key: string]: unknown;
1830
-
};
1831
-
};
1832
-
1833
-
export type TypesResponse = TypesResponses[keyof TypesResponses];
1834
-
1835
-
export type UploadFileData = {
1836
-
body: Blob | File;
1837
-
path: {
1838
-
/**
1839
-
* api-version should be required in standalone clients
1840
-
*/
1841
-
'api-version': string | null;
1842
-
};
1843
-
query?: never;
1844
-
url: '/api/v{api-version}/upload';
1845
-
};
1846
-
1847
-
export type UploadFileResponses = {
1848
-
200: boolean;
1849
-
};
1850
-
1851
-
export type UploadFileResponse = UploadFileResponses[keyof UploadFileResponses];
1852
-
1853
-
export type FileResponseData = {
1854
-
body?: never;
1855
-
path: {
1856
-
id: string;
1857
-
/**
1858
-
* api-version should be required in standalone clients
1859
-
*/
1860
-
'api-version': string;
1861
-
};
1862
-
query?: never;
1863
-
url: '/api/v{api-version}/file/{id}';
1864
-
};
1865
-
1866
-
export type FileResponseResponses = {
1867
-
/**
1868
-
* Success
1869
-
*/
1870
-
200: Blob | File;
1871
-
};
1872
-
1873
-
export type FileResponseResponse = FileResponseResponses[keyof FileResponseResponses];
1874
-
1875
-
export type ComplexTypesData = {
1876
-
body?: never;
1877
-
path?: never;
1878
-
query: {
1879
-
/**
1880
-
* Parameter containing object
1881
-
*/
1882
-
parameterObject: {
1883
-
first?: {
1884
-
second?: {
1885
-
third?: string;
1886
-
};
1887
-
};
1888
-
};
1889
-
/**
1890
-
* Parameter containing reference
1891
-
*/
1892
-
parameterReference: ModelWithString;
1893
-
};
1894
-
url: '/api/v{api-version}/complex';
1895
-
};
1896
-
1897
-
export type ComplexTypesErrors = {
1898
-
/**
1899
-
* 400 `server` error
1900
-
*/
1901
-
400: unknown;
1902
-
/**
1903
-
* 500 server error
1904
-
*/
1905
-
500: unknown;
1906
-
};
1907
-
1908
-
export type ComplexTypesResponses = {
1909
-
/**
1910
-
* Successful response
1911
-
*/
1912
-
200: Array<ModelWithString>;
1913
-
};
1914
-
1915
-
export type ComplexTypesResponse = ComplexTypesResponses[keyof ComplexTypesResponses];
1916
-
1917
-
export type MultipartResponseData = {
1918
-
body?: never;
1919
-
path?: never;
1920
-
query?: never;
1921
-
url: '/api/v{api-version}/multipart';
1922
-
};
1923
-
1924
-
export type MultipartResponseResponses = {
1925
-
/**
1926
-
* OK
1927
-
*/
1928
-
200: {
1929
-
file?: Blob | File;
1930
-
metadata?: {
1931
-
foo?: string;
1932
-
bar?: string;
1933
-
};
1934
-
};
1935
-
};
1936
-
1937
-
export type MultipartResponseResponse = MultipartResponseResponses[keyof MultipartResponseResponses];
1938
-
1939
-
export type MultipartRequestData = {
1940
-
body?: {
1941
-
content?: Blob | File;
1942
-
data?: ModelWithString | null;
1943
-
};
1944
-
path?: never;
1945
-
query?: never;
1946
-
url: '/api/v{api-version}/multipart';
1947
-
};
1948
-
1949
-
export type ComplexParamsData = {
1950
-
body?: {
1951
-
readonly key: string | null;
1952
-
name: string | null;
1953
-
enabled?: boolean;
1954
-
type: 'Monkey' | 'Horse' | 'Bird';
1955
-
listOfModels?: Array<ModelWithString> | null;
1956
-
listOfStrings?: Array<string> | null;
1957
-
parameters: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary;
1958
-
readonly user?: {
1959
-
readonly id?: number;
1960
-
readonly name?: string | null;
1961
-
};
1962
-
};
1963
-
path: {
1964
-
id: number;
1965
-
/**
1966
-
* api-version should be required in standalone clients
1967
-
*/
1968
-
'api-version': string;
1969
-
};
1970
-
query?: never;
1971
-
url: '/api/v{api-version}/complex/{id}';
1972
-
};
1973
-
1974
-
export type ComplexParamsResponses = {
1975
-
/**
1976
-
* Success
1977
-
*/
1978
-
200: ModelWithString;
1979
-
};
1980
-
1981
-
export type ComplexParamsResponse = ComplexParamsResponses[keyof ComplexParamsResponses];
1982
-
1983
-
export type CallWithResultFromHeaderData = {
1984
-
body?: never;
1985
-
path?: never;
1986
-
query?: never;
1987
-
url: '/api/v{api-version}/header';
1988
-
};
1989
-
1990
-
export type CallWithResultFromHeaderErrors = {
1991
-
/**
1992
-
* 400 server error
1993
-
*/
1994
-
400: unknown;
1995
-
/**
1996
-
* 500 server error
1997
-
*/
1998
-
500: unknown;
1999
-
};
2000
-
2001
-
export type CallWithResultFromHeaderResponses = {
2002
-
/**
2003
-
* Successful response
2004
-
*/
2005
-
200: unknown;
2006
-
};
2007
-
2008
-
export type TestErrorCodeData = {
2009
-
body?: never;
2010
-
path?: never;
2011
-
query: {
2012
-
/**
2013
-
* Status code to return
2014
-
*/
2015
-
status: number;
2016
-
};
2017
-
url: '/api/v{api-version}/error';
2018
-
};
2019
-
2020
-
export type TestErrorCodeErrors = {
2021
-
/**
2022
-
* Custom message: Internal Server Error
2023
-
*/
2024
-
500: unknown;
2025
-
/**
2026
-
* Custom message: Not Implemented
2027
-
*/
2028
-
501: unknown;
2029
-
/**
2030
-
* Custom message: Bad Gateway
2031
-
*/
2032
-
502: unknown;
2033
-
/**
2034
-
* Custom message: Service Unavailable
2035
-
*/
2036
-
503: unknown;
2037
-
};
2038
-
2039
-
export type TestErrorCodeResponses = {
2040
-
/**
2041
-
* Custom message: Successful response
2042
-
*/
2043
-
200: unknown;
2044
-
};
2045
-
2046
-
export type NonAsciiæøåÆøÅöôêÊ字符串Data = {
2047
-
body?: never;
2048
-
path?: never;
2049
-
query: {
2050
-
/**
2051
-
* Dummy input param
2052
-
*/
2053
-
nonAsciiParamæøåÆØÅöôêÊ: number;
2054
-
};
2055
-
url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串';
2056
-
};
2057
-
2058
-
export type NonAsciiæøåÆøÅöôêÊ字符串Responses = {
2059
-
/**
2060
-
* Successful response
2061
-
*/
2062
-
200: Array<NonAsciiStringæøåÆøÅöôêÊ字符串>;
2063
-
};
2064
-
2065
-
export type NonAsciiæøåÆøÅöôêÊ字符串Response = NonAsciiæøåÆøÅöôêÊ字符串Responses[keyof NonAsciiæøåÆøÅöôêÊ字符串Responses];
2066
-
2067
-
export type PutWithFormUrlEncodedData = {
2068
-
body: ArrayWithStrings;
2069
-
path?: never;
2070
-
query?: never;
2071
-
url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串';
2072
-
};
+67
-7
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/plugins/nestjs/default/nestjs.gen.ts
+67
-7
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/plugins/nestjs/default/nestjs.gen.ts
···
2
2
3
3
import type { ApiVVersionODataControllerCountResponse, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesResponse, CallWithNoContentResponseResponse, CallWithParametersData, CallWithResponseAndNoContentResponseResponse, CallWithResponseResponse, CallWithResponsesResponse, CallWithWeirdParameterNamesData, CollectionFormatData, ComplexParamsData, ComplexParamsResponse, ComplexTypesData, ComplexTypesResponse, DeleteFooData3, DeprecatedCallData, DummyAResponse, DummyBResponse, FileResponseData, FileResponseResponse, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationResponse, GetCallWithOptionalParamData, ImportData, ImportResponse, MultipartRequestData, MultipartResponseResponse, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponse, PutWithFormUrlEncodedData, TestErrorCodeData, TypesData, TypesResponse, UploadFileData, UploadFileResponse } from './types.gen';
4
4
5
-
export type ControllerMethods = {
5
+
export type DefaultControllerMethods = {
6
6
export: () => Promise<void>;
7
7
patchApiVbyApiVersionNoTag: () => Promise<void>;
8
8
import: (body: ImportData['body']) => Promise<ImportResponse>;
9
9
fooWow: () => Promise<void>;
10
-
apiVVersionODataControllerCount: () => Promise<ApiVVersionODataControllerCountResponse>;
11
10
getApiVbyApiVersionSimpleOperation: (path: GetApiVbyApiVersionSimpleOperationData['path']) => Promise<GetApiVbyApiVersionSimpleOperationResponse>;
11
+
};
12
+
13
+
export type SimpleControllerMethods = {
14
+
apiVVersionODataControllerCount: () => Promise<ApiVVersionODataControllerCountResponse>;
12
15
deleteCallWithoutParametersAndResponse: () => Promise<void>;
13
16
getCallWithoutParametersAndResponse: () => Promise<void>;
14
17
headCallWithoutParametersAndResponse: () => Promise<void>;
···
16
19
patchCallWithoutParametersAndResponse: () => Promise<void>;
17
20
postCallWithoutParametersAndResponse: () => Promise<void>;
18
21
putCallWithoutParametersAndResponse: () => Promise<void>;
22
+
};
23
+
24
+
export type ParametersControllerMethods = {
19
25
deleteFoo: (path: DeleteFooData3['path'], headers: DeleteFooData3['headers']) => Promise<void>;
20
-
callWithDescriptions: (query?: CallWithDescriptionsData['query']) => Promise<void>;
21
-
deprecatedCall: (headers: DeprecatedCallData['headers']) => Promise<void>;
22
26
callWithParameters: (path: CallWithParametersData['path'], query: CallWithParametersData['query'], body: CallWithParametersData['body'], headers: CallWithParametersData['headers']) => Promise<void>;
23
27
callWithWeirdParameterNames: (path: CallWithWeirdParameterNamesData['path'], query: CallWithWeirdParameterNamesData['query'], body: CallWithWeirdParameterNamesData['body'], headers: CallWithWeirdParameterNamesData['headers']) => Promise<void>;
24
28
getCallWithOptionalParam: (body: GetCallWithOptionalParamData['body'], query?: GetCallWithOptionalParamData['query']) => Promise<void>;
25
29
postCallWithOptionalParam: (query: PostCallWithOptionalParamData['query'], body?: PostCallWithOptionalParamData['body']) => Promise<PostCallWithOptionalParamResponse>;
30
+
};
31
+
32
+
export type DescriptionsControllerMethods = {
33
+
callWithDescriptions: (query?: CallWithDescriptionsData['query']) => Promise<void>;
34
+
};
35
+
36
+
export type DeprecatedControllerMethods = {
37
+
deprecatedCall: (headers: DeprecatedCallData['headers']) => Promise<void>;
38
+
};
39
+
40
+
export type RequestBodyControllerMethods = {
26
41
postApiVbyApiVersionRequestBody: (query?: PostApiVbyApiVersionRequestBodyData['query'], body?: PostApiVbyApiVersionRequestBodyData['body']) => Promise<void>;
42
+
};
43
+
44
+
export type FormDataControllerMethods = {
27
45
postApiVbyApiVersionFormData: (query?: PostApiVbyApiVersionFormDataData['query'], body?: PostApiVbyApiVersionFormDataData['body']) => Promise<void>;
46
+
};
47
+
48
+
export type DefaultsControllerMethods = {
28
49
callWithDefaultParameters: (query?: CallWithDefaultParametersData['query']) => Promise<void>;
29
50
callWithDefaultOptionalParameters: (query?: CallWithDefaultOptionalParametersData['query']) => Promise<void>;
30
51
callToTestOrderOfParams: (query: CallToTestOrderOfParamsData['query']) => Promise<void>;
52
+
};
53
+
54
+
export type DuplicateControllerMethods = {
31
55
duplicateName: () => Promise<void>;
32
56
duplicateName2: () => Promise<void>;
33
57
duplicateName3: () => Promise<void>;
34
58
duplicateName4: () => Promise<void>;
59
+
};
60
+
61
+
export type NoContentControllerMethods = {
35
62
callWithNoContentResponse: () => Promise<CallWithNoContentResponseResponse>;
63
+
};
64
+
65
+
export type ResponseControllerMethods = {
36
66
callWithResponseAndNoContentResponse: () => Promise<CallWithResponseAndNoContentResponseResponse>;
37
-
dummyA: () => Promise<DummyAResponse>;
38
-
dummyB: () => Promise<DummyBResponse>;
39
67
callWithResponse: () => Promise<CallWithResponseResponse>;
40
68
callWithDuplicateResponses: () => Promise<CallWithDuplicateResponsesResponse>;
41
69
callWithResponses: () => Promise<CallWithResponsesResponse>;
70
+
};
71
+
72
+
export type MultipleTags1ControllerMethods = {
73
+
dummyA: () => Promise<DummyAResponse>;
74
+
dummyB: () => Promise<DummyBResponse>;
75
+
};
76
+
77
+
export type CollectionFormatControllerMethods = {
42
78
collectionFormat: (query: CollectionFormatData['query']) => Promise<void>;
79
+
};
80
+
81
+
export type TypesControllerMethods = {
43
82
types: (query: TypesData['query'], path?: TypesData['path']) => Promise<TypesResponse>;
83
+
};
84
+
85
+
export type UploadControllerMethods = {
44
86
uploadFile: (path: UploadFileData['path'], body: UploadFileData['body']) => Promise<UploadFileResponse>;
87
+
};
88
+
89
+
export type FileResponseControllerMethods = {
45
90
fileResponse: (path: FileResponseData['path']) => Promise<FileResponseResponse>;
91
+
};
92
+
93
+
export type ComplexControllerMethods = {
46
94
complexTypes: (query: ComplexTypesData['query']) => Promise<ComplexTypesResponse>;
95
+
complexParams: (path: ComplexParamsData['path'], body?: ComplexParamsData['body']) => Promise<ComplexParamsResponse>;
96
+
};
97
+
98
+
export type MultipartControllerMethods = {
47
99
multipartResponse: () => Promise<MultipartResponseResponse>;
48
100
multipartRequest: (body?: MultipartRequestData['body']) => Promise<void>;
49
-
complexParams: (path: ComplexParamsData['path'], body?: ComplexParamsData['body']) => Promise<ComplexParamsResponse>;
101
+
};
102
+
103
+
export type HeaderControllerMethods = {
50
104
callWithResultFromHeader: () => Promise<void>;
105
+
};
106
+
107
+
export type ErrorControllerMethods = {
51
108
testErrorCode: (query: TestErrorCodeData['query']) => Promise<void>;
109
+
};
110
+
111
+
export type NonAsciiÆøåÆøÅöôêÊControllerMethods = {
52
112
nonAsciiæøåÆøÅöôêÊ字符串: (query: NonAsciiæøåÆøÅöôêÊ字符串Data['query']) => Promise<NonAsciiæøåÆøÅöôêÊ字符串Response>;
53
113
putWithFormUrlEncoded: (body: PutWithFormUrlEncodedData['body']) => Promise<void>;
54
114
};
-3
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/plugins/nestjs/group-by-tag/index.ts
-3
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/plugins/nestjs/group-by-tag/index.ts
···
1
-
// This file is auto-generated by @hey-api/openapi-ts
2
-
3
-
export type { _3eNum1Период, _400, AdditionalPropertiesIntegerIssue, AdditionalPropertiesUnknownIssue, AdditionalPropertiesUnknownIssue2, AdditionalPropertiesUnknownIssue3, AdditionalPropertiesUnknownIssueWritable, AnyOfAnyAndNull, AnyOfArrays, ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponse, ApiVVersionODataControllerCountResponses, ArrayWithAnyOfProperties, ArrayWithArray, ArrayWithBooleans, ArrayWithNumbers, ArrayWithProperties, ArrayWithReferences, ArrayWithStrings, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesError, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponse, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponse, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponse, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesError, CallWithResponsesErrors, CallWithResponsesResponse, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, CamelCaseCommentWithBreaks, CharactersInDescription, ClientOptions, CollectionFormatData, CommentWithBackticks, CommentWithBackticksAndQuotes, CommentWithBreaks, CommentWithExpressionPlaceholders, CommentWithQuotes, CommentWithReservedCharacters, CommentWithSlashes, ComplexParamsData, ComplexParamsResponse, ComplexParamsResponses, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponse, ComplexTypesResponses, CompositionBaseModel, CompositionExtendedModel, CompositionWithAllOfAndNullable, CompositionWithAnyOf, CompositionWithAnyOfAndNullable, CompositionWithAnyOfAnonymous, CompositionWithNestedAnyAndTypeNull, CompositionWithNestedAnyOfAndNull, CompositionWithOneOf, CompositionWithOneOfAndComplexArrayDictionary, CompositionWithOneOfAndNullable, CompositionWithOneOfAndProperties, CompositionWithOneOfAndSimpleArrayDictionary, CompositionWithOneOfAndSimpleDictionary, CompositionWithOneOfAnonymous, CompositionWithOneOfDiscriminator, ConstValue, Default, DeleteCallWithoutParametersAndResponseData, DeleteFooData, DeleteFooData2, DeleteFooData3, DeprecatedCallData, DeprecatedModel, DictionaryWithArray, DictionaryWithDictionary, DictionaryWithProperties, DictionaryWithPropertiesAndAdditionalProperties, DictionaryWithReference, DictionaryWithString, DummyAData, DummyAResponse, DummyAResponses, DummyBData, DummyBResponse, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, EnumFromDescription, EnumWithExtensions, EnumWithNumbers, EnumWithReplacedCharacters, EnumWithStrings, EnumWithXEnumNames, ExportData, ExternalRefA, ExternalRefB, ExternalSharedExternalSharedModel, File, FileResponseData, FileResponseResponse, FileResponseResponses, FileWritable, FooWowData, FooWowResponses, FreeFormObjectWithAdditionalPropertiesEqEmptyObject, FreeFormObjectWithAdditionalPropertiesEqTrue, FreeFormObjectWithoutAdditionalProperties, GenericSchemaDuplicateIssue1SystemBoolean, GenericSchemaDuplicateIssue1SystemBooleanWritable, GenericSchemaDuplicateIssue1SystemString, GenericSchemaDuplicateIssue1SystemStringWritable, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationError, GetApiVbyApiVersionSimpleOperationErrors, GetApiVbyApiVersionSimpleOperationResponse, GetApiVbyApiVersionSimpleOperationResponses, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, Import, ImportData, ImportResponse, ImportResponses, IoK8sApimachineryPkgApisMetaV1DeleteOptions, IoK8sApimachineryPkgApisMetaV1Preconditions, ModelCircle, ModelFromZendesk, ModelSquare, ModelThatExtends, ModelThatExtendsExtends, ModelWithAdditionalPropertiesEqTrue, ModelWithAnyOfConstantSizeArray, ModelWithAnyOfConstantSizeArrayAndIntersect, ModelWithAnyOfConstantSizeArrayNullable, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable, ModelWithArray, ModelWithArrayReadOnlyAndWriteOnly, ModelWithArrayReadOnlyAndWriteOnlyWritable, ModelWithBackticksInDescription, ModelWithBoolean, ModelWithCircularReference, ModelWithConst, ModelWithConstantSizeArray, ModelWithDictionary, ModelWithDuplicateImports, ModelWithDuplicateProperties, ModelWithEnum, ModelWithEnumFromDescription, ModelWithEnumWithHyphen, ModelWithInteger, ModelWithNestedArrayEnums, ModelWithNestedArrayEnumsData, ModelWithNestedArrayEnumsDataBar, ModelWithNestedArrayEnumsDataFoo, ModelWithNestedCompositionEnums, ModelWithNestedEnums, ModelWithNestedProperties, ModelWithNullableObject, ModelWithNullableString, ModelWithNumericEnumUnion, ModelWithOneOfAndProperties, ModelWithOneOfEnum, ModelWithOrderedProperties, ModelWithPattern, ModelWithPatternWritable, ModelWithPrefixItemsConstantSizeArray, ModelWithProperties, ModelWithPropertiesWritable, ModelWithReadOnlyAndWriteOnly, ModelWithReadOnlyAndWriteOnlyWritable, ModelWithReference, ModelWithReferenceWritable, ModelWithString, ModelWithStringError, MultipartRequestData, MultipartResponseData, MultipartResponseResponse, MultipartResponseResponses, NestedAnyOfArraysNullable, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, NonAsciiæøåÆøÅöôêÊ字符串Responses, NonAsciiStringæøåÆøÅöôêÊ字符串, NullableObject, OneOfAllOfIssue, OneOfAllOfIssueWritable, OptionsCallWithoutParametersAndResponseData, Pageable, ParameterSimpleParameterUnused, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponse, PostCallWithOptionalParamResponses, PostCallWithoutParametersAndResponseData, PostServiceWithEmptyTagResponse, PostServiceWithEmptyTagResponse2, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, SchemaWithFormRestrictedKeys, SimpleBoolean, SimpleFile, SimpleFormData, SimpleInteger, SimpleParameter, SimpleReference, SimpleRequestBody, SimpleString, SimpleStringWithPattern, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponse, TypesResponses, UploadFileData, UploadFileResponse, UploadFileResponses, XFooBar } from './types.gen';
-114
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/plugins/nestjs/group-by-tag/nestjs.gen.ts
-114
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/plugins/nestjs/group-by-tag/nestjs.gen.ts
···
1
-
// This file is auto-generated by @hey-api/openapi-ts
2
-
3
-
import type { ApiVVersionODataControllerCountResponse, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesResponse, CallWithNoContentResponseResponse, CallWithParametersData, CallWithResponseAndNoContentResponseResponse, CallWithResponseResponse, CallWithResponsesResponse, CallWithWeirdParameterNamesData, CollectionFormatData, ComplexParamsData, ComplexParamsResponse, ComplexTypesData, ComplexTypesResponse, DeleteFooData3, DeprecatedCallData, DummyAResponse, DummyBResponse, FileResponseData, FileResponseResponse, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationResponse, GetCallWithOptionalParamData, ImportData, ImportResponse, MultipartRequestData, MultipartResponseResponse, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponse, PutWithFormUrlEncodedData, TestErrorCodeData, TypesData, TypesResponse, UploadFileData, UploadFileResponse } from './types.gen';
4
-
5
-
export type DefaultControllerMethods = {
6
-
export: () => Promise<void>;
7
-
patchApiVbyApiVersionNoTag: () => Promise<void>;
8
-
import: (body: ImportData['body']) => Promise<ImportResponse>;
9
-
fooWow: () => Promise<void>;
10
-
getApiVbyApiVersionSimpleOperation: (path: GetApiVbyApiVersionSimpleOperationData['path']) => Promise<GetApiVbyApiVersionSimpleOperationResponse>;
11
-
};
12
-
13
-
export type SimpleControllerMethods = {
14
-
apiVVersionODataControllerCount: () => Promise<ApiVVersionODataControllerCountResponse>;
15
-
deleteCallWithoutParametersAndResponse: () => Promise<void>;
16
-
getCallWithoutParametersAndResponse: () => Promise<void>;
17
-
headCallWithoutParametersAndResponse: () => Promise<void>;
18
-
optionsCallWithoutParametersAndResponse: () => Promise<void>;
19
-
patchCallWithoutParametersAndResponse: () => Promise<void>;
20
-
postCallWithoutParametersAndResponse: () => Promise<void>;
21
-
putCallWithoutParametersAndResponse: () => Promise<void>;
22
-
};
23
-
24
-
export type ParametersControllerMethods = {
25
-
deleteFoo: (path: DeleteFooData3['path'], headers: DeleteFooData3['headers']) => Promise<void>;
26
-
callWithParameters: (path: CallWithParametersData['path'], query: CallWithParametersData['query'], body: CallWithParametersData['body'], headers: CallWithParametersData['headers']) => Promise<void>;
27
-
callWithWeirdParameterNames: (path: CallWithWeirdParameterNamesData['path'], query: CallWithWeirdParameterNamesData['query'], body: CallWithWeirdParameterNamesData['body'], headers: CallWithWeirdParameterNamesData['headers']) => Promise<void>;
28
-
getCallWithOptionalParam: (body: GetCallWithOptionalParamData['body'], query?: GetCallWithOptionalParamData['query']) => Promise<void>;
29
-
postCallWithOptionalParam: (query: PostCallWithOptionalParamData['query'], body?: PostCallWithOptionalParamData['body']) => Promise<PostCallWithOptionalParamResponse>;
30
-
};
31
-
32
-
export type DescriptionsControllerMethods = {
33
-
callWithDescriptions: (query?: CallWithDescriptionsData['query']) => Promise<void>;
34
-
};
35
-
36
-
export type DeprecatedControllerMethods = {
37
-
deprecatedCall: (headers: DeprecatedCallData['headers']) => Promise<void>;
38
-
};
39
-
40
-
export type RequestBodyControllerMethods = {
41
-
postApiVbyApiVersionRequestBody: (query?: PostApiVbyApiVersionRequestBodyData['query'], body?: PostApiVbyApiVersionRequestBodyData['body']) => Promise<void>;
42
-
};
43
-
44
-
export type FormDataControllerMethods = {
45
-
postApiVbyApiVersionFormData: (query?: PostApiVbyApiVersionFormDataData['query'], body?: PostApiVbyApiVersionFormDataData['body']) => Promise<void>;
46
-
};
47
-
48
-
export type DefaultsControllerMethods = {
49
-
callWithDefaultParameters: (query?: CallWithDefaultParametersData['query']) => Promise<void>;
50
-
callWithDefaultOptionalParameters: (query?: CallWithDefaultOptionalParametersData['query']) => Promise<void>;
51
-
callToTestOrderOfParams: (query: CallToTestOrderOfParamsData['query']) => Promise<void>;
52
-
};
53
-
54
-
export type DuplicateControllerMethods = {
55
-
duplicateName: () => Promise<void>;
56
-
duplicateName2: () => Promise<void>;
57
-
duplicateName3: () => Promise<void>;
58
-
duplicateName4: () => Promise<void>;
59
-
};
60
-
61
-
export type NoContentControllerMethods = {
62
-
callWithNoContentResponse: () => Promise<CallWithNoContentResponseResponse>;
63
-
};
64
-
65
-
export type ResponseControllerMethods = {
66
-
callWithResponseAndNoContentResponse: () => Promise<CallWithResponseAndNoContentResponseResponse>;
67
-
callWithResponse: () => Promise<CallWithResponseResponse>;
68
-
callWithDuplicateResponses: () => Promise<CallWithDuplicateResponsesResponse>;
69
-
callWithResponses: () => Promise<CallWithResponsesResponse>;
70
-
};
71
-
72
-
export type MultipleTags1ControllerMethods = {
73
-
dummyA: () => Promise<DummyAResponse>;
74
-
dummyB: () => Promise<DummyBResponse>;
75
-
};
76
-
77
-
export type CollectionFormatControllerMethods = {
78
-
collectionFormat: (query: CollectionFormatData['query']) => Promise<void>;
79
-
};
80
-
81
-
export type TypesControllerMethods = {
82
-
types: (query: TypesData['query'], path?: TypesData['path']) => Promise<TypesResponse>;
83
-
};
84
-
85
-
export type UploadControllerMethods = {
86
-
uploadFile: (path: UploadFileData['path'], body: UploadFileData['body']) => Promise<UploadFileResponse>;
87
-
};
88
-
89
-
export type FileResponseControllerMethods = {
90
-
fileResponse: (path: FileResponseData['path']) => Promise<FileResponseResponse>;
91
-
};
92
-
93
-
export type ComplexControllerMethods = {
94
-
complexTypes: (query: ComplexTypesData['query']) => Promise<ComplexTypesResponse>;
95
-
complexParams: (path: ComplexParamsData['path'], body?: ComplexParamsData['body']) => Promise<ComplexParamsResponse>;
96
-
};
97
-
98
-
export type MultipartControllerMethods = {
99
-
multipartResponse: () => Promise<MultipartResponseResponse>;
100
-
multipartRequest: (body?: MultipartRequestData['body']) => Promise<void>;
101
-
};
102
-
103
-
export type HeaderControllerMethods = {
104
-
callWithResultFromHeader: () => Promise<void>;
105
-
};
106
-
107
-
export type ErrorControllerMethods = {
108
-
testErrorCode: (query: TestErrorCodeData['query']) => Promise<void>;
109
-
};
110
-
111
-
export type NonAsciiÆøåÆøÅöôêÊControllerMethods = {
112
-
nonAsciiæøåÆøÅöôêÊ字符串: (query: NonAsciiæøåÆøÅöôêÊ字符串Data['query']) => Promise<NonAsciiæøåÆøÅöôêÊ字符串Response>;
113
-
putWithFormUrlEncoded: (body: PutWithFormUrlEncodedData['body']) => Promise<void>;
114
-
};
-2091
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/plugins/nestjs/group-by-tag/types.gen.ts
-2091
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/plugins/nestjs/group-by-tag/types.gen.ts
···
1
-
// This file is auto-generated by @hey-api/openapi-ts
2
-
3
-
export type ClientOptions = {
4
-
baseUrl: 'http://localhost:3000/base' | (string & {});
5
-
};
6
-
7
-
/**
8
-
* Model with number-only name
9
-
*/
10
-
export type _400 = string;
11
-
12
-
/**
13
-
* External ref to shared model (A)
14
-
*/
15
-
export type ExternalRefA = ExternalSharedExternalSharedModel;
16
-
17
-
/**
18
-
* External ref to shared model (B)
19
-
*/
20
-
export type ExternalRefB = ExternalSharedExternalSharedModel;
21
-
22
-
/**
23
-
* Testing multiline comments in string: First line
24
-
* Second line
25
-
*
26
-
* Fourth line
27
-
*/
28
-
export type CamelCaseCommentWithBreaks = number;
29
-
30
-
/**
31
-
* Testing multiline comments in string: First line
32
-
* Second line
33
-
*
34
-
* Fourth line
35
-
*/
36
-
export type CommentWithBreaks = number;
37
-
38
-
/**
39
-
* Testing backticks in string: `backticks` and ```multiple backticks``` should work
40
-
*/
41
-
export type CommentWithBackticks = number;
42
-
43
-
/**
44
-
* Testing backticks and quotes in string: `backticks`, 'quotes', "double quotes" and ```multiple backticks``` should work
45
-
*/
46
-
export type CommentWithBackticksAndQuotes = number;
47
-
48
-
/**
49
-
* Testing slashes in string: \backwards\\\ and /forwards/// should work
50
-
*/
51
-
export type CommentWithSlashes = number;
52
-
53
-
/**
54
-
* Testing expression placeholders in string: ${expression} should work
55
-
*/
56
-
export type CommentWithExpressionPlaceholders = number;
57
-
58
-
/**
59
-
* Testing quotes in string: 'single quote''' and "double quotes""" should work
60
-
*/
61
-
export type CommentWithQuotes = number;
62
-
63
-
/**
64
-
* Testing reserved characters in string: * inline * and ** inline ** should work
65
-
*/
66
-
export type CommentWithReservedCharacters = number;
67
-
68
-
/**
69
-
* This is a simple number
70
-
*/
71
-
export type SimpleInteger = number;
72
-
73
-
/**
74
-
* This is a simple boolean
75
-
*/
76
-
export type SimpleBoolean = boolean;
77
-
78
-
/**
79
-
* This is a simple string
80
-
*/
81
-
export type SimpleString = string;
82
-
83
-
/**
84
-
* A string with non-ascii (unicode) characters valid in typescript identifiers (æøåÆØÅöÔèÈ字符串)
85
-
*/
86
-
export type NonAsciiStringæøåÆøÅöôêÊ字符串 = string;
87
-
88
-
/**
89
-
* This is a simple file
90
-
*/
91
-
export type SimpleFile = Blob | File;
92
-
93
-
/**
94
-
* This is a simple reference
95
-
*/
96
-
export type SimpleReference = ModelWithString;
97
-
98
-
/**
99
-
* This is a simple string
100
-
*/
101
-
export type SimpleStringWithPattern = string | null;
102
-
103
-
/**
104
-
* This is a simple enum with strings
105
-
*/
106
-
export type EnumWithStrings = 'Success' | 'Warning' | 'Error' | '\'Single Quote\'' | '"Double Quotes"' | 'Non-ascii: øæåôöØÆÅÔÖ字符串';
107
-
108
-
export type EnumWithReplacedCharacters = '\'Single Quote\'' | '"Double Quotes"' | 'øæåôöØÆÅÔÖ字符串' | 3.1 | '';
109
-
110
-
/**
111
-
* This is a simple enum with numbers
112
-
*/
113
-
export type EnumWithNumbers = 1 | 2 | 3 | 1.1 | 1.2 | 1.3 | 100 | 200 | 300 | -100 | -200 | -300 | -1.1 | -1.2 | -1.3;
114
-
115
-
/**
116
-
* Success=1,Warning=2,Error=3
117
-
*/
118
-
export type EnumFromDescription = number;
119
-
120
-
/**
121
-
* This is a simple enum with numbers
122
-
*/
123
-
export type EnumWithExtensions = 200 | 400 | 500;
124
-
125
-
export type EnumWithXEnumNames = 0 | 1 | 2;
126
-
127
-
/**
128
-
* This is a simple array with numbers
129
-
*/
130
-
export type ArrayWithNumbers = Array<number>;
131
-
132
-
/**
133
-
* This is a simple array with booleans
134
-
*/
135
-
export type ArrayWithBooleans = Array<boolean>;
136
-
137
-
/**
138
-
* This is a simple array with strings
139
-
*/
140
-
export type ArrayWithStrings = Array<string>;
141
-
142
-
/**
143
-
* This is a simple array with references
144
-
*/
145
-
export type ArrayWithReferences = Array<ModelWithString>;
146
-
147
-
/**
148
-
* This is a simple array containing an array
149
-
*/
150
-
export type ArrayWithArray = Array<Array<ModelWithString>>;
151
-
152
-
/**
153
-
* This is a simple array with properties
154
-
*/
155
-
export type ArrayWithProperties = Array<{
156
-
'16x16'?: CamelCaseCommentWithBreaks;
157
-
bar?: string;
158
-
}>;
159
-
160
-
/**
161
-
* This is a simple array with any of properties
162
-
*/
163
-
export type ArrayWithAnyOfProperties = Array<{
164
-
foo?: string;
165
-
} | {
166
-
bar?: string;
167
-
}>;
168
-
169
-
export type AnyOfAnyAndNull = {
170
-
data?: unknown | null;
171
-
};
172
-
173
-
/**
174
-
* This is a simple array with any of properties
175
-
*/
176
-
export type AnyOfArrays = {
177
-
results?: Array<{
178
-
foo?: string;
179
-
} | {
180
-
bar?: string;
181
-
}>;
182
-
};
183
-
184
-
/**
185
-
* This is a string dictionary
186
-
*/
187
-
export type DictionaryWithString = {
188
-
[key: string]: string;
189
-
};
190
-
191
-
export type DictionaryWithPropertiesAndAdditionalProperties = {
192
-
foo?: number;
193
-
bar?: boolean;
194
-
[key: string]: string | number | boolean | undefined;
195
-
};
196
-
197
-
/**
198
-
* This is a string reference
199
-
*/
200
-
export type DictionaryWithReference = {
201
-
[key: string]: ModelWithString;
202
-
};
203
-
204
-
/**
205
-
* This is a complex dictionary
206
-
*/
207
-
export type DictionaryWithArray = {
208
-
[key: string]: Array<ModelWithString>;
209
-
};
210
-
211
-
/**
212
-
* This is a string dictionary
213
-
*/
214
-
export type DictionaryWithDictionary = {
215
-
[key: string]: {
216
-
[key: string]: string;
217
-
};
218
-
};
219
-
220
-
/**
221
-
* This is a complex dictionary
222
-
*/
223
-
export type DictionaryWithProperties = {
224
-
[key: string]: {
225
-
foo?: string;
226
-
bar?: string;
227
-
};
228
-
};
229
-
230
-
/**
231
-
* This is a model with one number property
232
-
*/
233
-
export type ModelWithInteger = {
234
-
/**
235
-
* This is a simple number property
236
-
*/
237
-
prop?: number;
238
-
};
239
-
240
-
/**
241
-
* This is a model with one boolean property
242
-
*/
243
-
export type ModelWithBoolean = {
244
-
/**
245
-
* This is a simple boolean property
246
-
*/
247
-
prop?: boolean;
248
-
};
249
-
250
-
/**
251
-
* This is a model with one string property
252
-
*/
253
-
export type ModelWithString = {
254
-
/**
255
-
* This is a simple string property
256
-
*/
257
-
prop?: string;
258
-
};
259
-
260
-
/**
261
-
* This is a model with one string property
262
-
*/
263
-
export type ModelWithStringError = {
264
-
/**
265
-
* This is a simple string property
266
-
*/
267
-
prop?: string;
268
-
};
269
-
270
-
/**
271
-
* `Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets)
272
-
*/
273
-
export type ModelFromZendesk = string;
274
-
275
-
/**
276
-
* This is a model with one string property
277
-
*/
278
-
export type ModelWithNullableString = {
279
-
/**
280
-
* This is a simple string property
281
-
*/
282
-
nullableProp1?: string | null;
283
-
/**
284
-
* This is a simple string property
285
-
*/
286
-
nullableRequiredProp1: string | null;
287
-
/**
288
-
* This is a simple string property
289
-
*/
290
-
nullableProp2?: string | null;
291
-
/**
292
-
* This is a simple string property
293
-
*/
294
-
nullableRequiredProp2: string | null;
295
-
/**
296
-
* This is a simple enum with strings
297
-
*/
298
-
'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串';
299
-
};
300
-
301
-
/**
302
-
* This is a model with one enum
303
-
*/
304
-
export type ModelWithEnum = {
305
-
/**
306
-
* This is a simple enum with strings
307
-
*/
308
-
'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串';
309
-
/**
310
-
* These are the HTTP error code enums
311
-
*/
312
-
statusCode?: '100' | '200 FOO' | '300 FOO_BAR' | '400 foo-bar' | '500 foo.bar' | '600 foo&bar';
313
-
/**
314
-
* Simple boolean enum
315
-
*/
316
-
bool?: true;
317
-
};
318
-
319
-
/**
320
-
* This is a model with one enum with escaped name
321
-
*/
322
-
export type ModelWithEnumWithHyphen = {
323
-
/**
324
-
* Foo-Bar-Baz-Qux
325
-
*/
326
-
'foo-bar-baz-qux'?: '3.0';
327
-
};
328
-
329
-
/**
330
-
* This is a model with one enum
331
-
*/
332
-
export type ModelWithEnumFromDescription = {
333
-
/**
334
-
* Success=1,Warning=2,Error=3
335
-
*/
336
-
test?: number;
337
-
};
338
-
339
-
/**
340
-
* This is a model with nested enums
341
-
*/
342
-
export type ModelWithNestedEnums = {
343
-
dictionaryWithEnum?: {
344
-
[key: string]: 'Success' | 'Warning' | 'Error';
345
-
};
346
-
dictionaryWithEnumFromDescription?: {
347
-
[key: string]: number;
348
-
};
349
-
arrayWithEnum?: Array<'Success' | 'Warning' | 'Error'>;
350
-
arrayWithDescription?: Array<number>;
351
-
/**
352
-
* This is a simple enum with strings
353
-
*/
354
-
'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串';
355
-
};
356
-
357
-
/**
358
-
* This is a model with one property containing a reference
359
-
*/
360
-
export type ModelWithReference = {
361
-
prop?: ModelWithProperties;
362
-
};
363
-
364
-
/**
365
-
* This is a model with one property containing an array
366
-
*/
367
-
export type ModelWithArrayReadOnlyAndWriteOnly = {
368
-
prop?: Array<ModelWithReadOnlyAndWriteOnly>;
369
-
propWithFile?: Array<Blob | File>;
370
-
propWithNumber?: Array<number>;
371
-
};
372
-
373
-
/**
374
-
* This is a model with one property containing an array
375
-
*/
376
-
export type ModelWithArray = {
377
-
prop?: Array<ModelWithString>;
378
-
propWithFile?: Array<Blob | File>;
379
-
propWithNumber?: Array<number>;
380
-
};
381
-
382
-
/**
383
-
* This is a model with one property containing a dictionary
384
-
*/
385
-
export type ModelWithDictionary = {
386
-
prop?: {
387
-
[key: string]: string;
388
-
};
389
-
};
390
-
391
-
/**
392
-
* This is a deprecated model with a deprecated property
393
-
*
394
-
* @deprecated
395
-
*/
396
-
export type DeprecatedModel = {
397
-
/**
398
-
* This is a deprecated property
399
-
*
400
-
* @deprecated
401
-
*/
402
-
prop?: string;
403
-
};
404
-
405
-
/**
406
-
* This is a model with one property containing a circular reference
407
-
*/
408
-
export type ModelWithCircularReference = {
409
-
prop?: ModelWithCircularReference;
410
-
};
411
-
412
-
/**
413
-
* This is a model with one property with a 'one of' relationship
414
-
*/
415
-
export type CompositionWithOneOf = {
416
-
propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary;
417
-
};
418
-
419
-
/**
420
-
* This is a model with one property with a 'one of' relationship where the options are not $ref
421
-
*/
422
-
export type CompositionWithOneOfAnonymous = {
423
-
propA?: {
424
-
propA?: string;
425
-
} | string | number;
426
-
};
427
-
428
-
/**
429
-
* Circle
430
-
*/
431
-
export type ModelCircle = {
432
-
kind: string;
433
-
radius?: number;
434
-
};
435
-
436
-
/**
437
-
* Square
438
-
*/
439
-
export type ModelSquare = {
440
-
kind: string;
441
-
sideLength?: number;
442
-
};
443
-
444
-
/**
445
-
* This is a model with one property with a 'one of' relationship where the options are not $ref
446
-
*/
447
-
export type CompositionWithOneOfDiscriminator = ({
448
-
kind: 'circle';
449
-
} & ModelCircle) | ({
450
-
kind: 'square';
451
-
} & ModelSquare);
452
-
453
-
/**
454
-
* This is a model with one property with a 'any of' relationship
455
-
*/
456
-
export type CompositionWithAnyOf = {
457
-
propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary;
458
-
};
459
-
460
-
/**
461
-
* This is a model with one property with a 'any of' relationship where the options are not $ref
462
-
*/
463
-
export type CompositionWithAnyOfAnonymous = {
464
-
propA?: {
465
-
propA?: string;
466
-
} | string | number;
467
-
};
468
-
469
-
/**
470
-
* This is a model with nested 'any of' property with a type null
471
-
*/
472
-
export type CompositionWithNestedAnyAndTypeNull = {
473
-
propA?: Array<ModelWithDictionary | null> | Array<ModelWithArray | null>;
474
-
};
475
-
476
-
export type _3eNum1Период = 'Bird' | 'Dog';
477
-
478
-
export type ConstValue = 'ConstValue';
479
-
480
-
/**
481
-
* This is a model with one property with a 'any of' relationship where the options are not $ref
482
-
*/
483
-
export type CompositionWithNestedAnyOfAndNull = {
484
-
/**
485
-
* Scopes
486
-
*/
487
-
propA?: Array<_3eNum1Период | ConstValue> | null;
488
-
};
489
-
490
-
/**
491
-
* This is a model with one property with a 'one of' relationship
492
-
*/
493
-
export type CompositionWithOneOfAndNullable = {
494
-
propA?: {
495
-
boolean?: boolean;
496
-
} | ModelWithEnum | ModelWithArray | ModelWithDictionary | null;
497
-
};
498
-
499
-
/**
500
-
* This is a model that contains a simple dictionary within composition
501
-
*/
502
-
export type CompositionWithOneOfAndSimpleDictionary = {
503
-
propA?: boolean | {
504
-
[key: string]: number;
505
-
};
506
-
};
507
-
508
-
/**
509
-
* This is a model that contains a dictionary of simple arrays within composition
510
-
*/
511
-
export type CompositionWithOneOfAndSimpleArrayDictionary = {
512
-
propA?: boolean | {
513
-
[key: string]: Array<boolean>;
514
-
};
515
-
};
516
-
517
-
/**
518
-
* This is a model that contains a dictionary of complex arrays (composited) within composition
519
-
*/
520
-
export type CompositionWithOneOfAndComplexArrayDictionary = {
521
-
propA?: boolean | {
522
-
[key: string]: Array<number | string>;
523
-
};
524
-
};
525
-
526
-
/**
527
-
* This is a model with one property with a 'all of' relationship
528
-
*/
529
-
export type CompositionWithAllOfAndNullable = {
530
-
propA?: ({
531
-
boolean?: boolean;
532
-
} & ModelWithEnum & ModelWithArray & ModelWithDictionary) | null;
533
-
};
534
-
535
-
/**
536
-
* This is a model with one property with a 'any of' relationship
537
-
*/
538
-
export type CompositionWithAnyOfAndNullable = {
539
-
propA?: {
540
-
boolean?: boolean;
541
-
} | ModelWithEnum | ModelWithArray | ModelWithDictionary | null;
542
-
};
543
-
544
-
/**
545
-
* This is a base model with two simple optional properties
546
-
*/
547
-
export type CompositionBaseModel = {
548
-
firstName?: string;
549
-
lastname?: string;
550
-
};
551
-
552
-
/**
553
-
* This is a model that extends the base model
554
-
*/
555
-
export type CompositionExtendedModel = CompositionBaseModel & {
556
-
age: number;
557
-
firstName: string;
558
-
lastname: string;
559
-
};
560
-
561
-
/**
562
-
* This is a model with one nested property
563
-
*/
564
-
export type ModelWithProperties = {
565
-
required: string;
566
-
readonly requiredAndReadOnly: string;
567
-
requiredAndNullable: string | null;
568
-
string?: string;
569
-
number?: number;
570
-
boolean?: boolean;
571
-
reference?: ModelWithString;
572
-
'property with space'?: string;
573
-
default?: string;
574
-
try?: string;
575
-
readonly '@namespace.string'?: string;
576
-
readonly '@namespace.integer'?: number;
577
-
};
578
-
579
-
/**
580
-
* This is a model with one nested property
581
-
*/
582
-
export type ModelWithNestedProperties = {
583
-
readonly first: {
584
-
readonly second: {
585
-
readonly third: string | null;
586
-
} | null;
587
-
} | null;
588
-
};
589
-
590
-
/**
591
-
* This is a model with duplicated properties
592
-
*/
593
-
export type ModelWithDuplicateProperties = {
594
-
prop?: ModelWithString;
595
-
};
596
-
597
-
/**
598
-
* This is a model with ordered properties
599
-
*/
600
-
export type ModelWithOrderedProperties = {
601
-
zebra?: string;
602
-
apple?: string;
603
-
hawaii?: string;
604
-
};
605
-
606
-
/**
607
-
* This is a model with duplicated imports
608
-
*/
609
-
export type ModelWithDuplicateImports = {
610
-
propA?: ModelWithString;
611
-
propB?: ModelWithString;
612
-
propC?: ModelWithString;
613
-
};
614
-
615
-
/**
616
-
* This is a model that extends another model
617
-
*/
618
-
export type ModelThatExtends = ModelWithString & {
619
-
propExtendsA?: string;
620
-
propExtendsB?: ModelWithString;
621
-
};
622
-
623
-
/**
624
-
* This is a model that extends another model
625
-
*/
626
-
export type ModelThatExtendsExtends = ModelWithString & ModelThatExtends & {
627
-
propExtendsC?: string;
628
-
propExtendsD?: ModelWithString;
629
-
};
630
-
631
-
/**
632
-
* This is a model that contains a some patterns
633
-
*/
634
-
export type ModelWithPattern = {
635
-
key: string;
636
-
name: string;
637
-
readonly enabled?: boolean;
638
-
readonly modified?: string;
639
-
id?: string;
640
-
text?: string;
641
-
patternWithSingleQuotes?: string;
642
-
patternWithNewline?: string;
643
-
patternWithBacktick?: string;
644
-
};
645
-
646
-
export type File = {
647
-
/**
648
-
* Id
649
-
*/
650
-
readonly id?: string;
651
-
/**
652
-
* Updated at
653
-
*/
654
-
readonly updated_at?: string;
655
-
/**
656
-
* Created at
657
-
*/
658
-
readonly created_at?: string;
659
-
/**
660
-
* Mime
661
-
*/
662
-
mime: string;
663
-
/**
664
-
* File
665
-
*/
666
-
readonly file?: string;
667
-
};
668
-
669
-
export type Default = {
670
-
name?: string;
671
-
};
672
-
673
-
export type Pageable = {
674
-
page?: number;
675
-
size?: number;
676
-
sort?: Array<string>;
677
-
};
678
-
679
-
/**
680
-
* This is a free-form object without additionalProperties.
681
-
*/
682
-
export type FreeFormObjectWithoutAdditionalProperties = {
683
-
[key: string]: unknown;
684
-
};
685
-
686
-
/**
687
-
* This is a free-form object with additionalProperties: true.
688
-
*/
689
-
export type FreeFormObjectWithAdditionalPropertiesEqTrue = {
690
-
[key: string]: unknown;
691
-
};
692
-
693
-
/**
694
-
* This is a free-form object with additionalProperties: {}.
695
-
*/
696
-
export type FreeFormObjectWithAdditionalPropertiesEqEmptyObject = {
697
-
[key: string]: unknown;
698
-
};
699
-
700
-
export type ModelWithConst = {
701
-
String?: 'String';
702
-
number?: 0;
703
-
null?: null;
704
-
withType?: 'Some string';
705
-
};
706
-
707
-
/**
708
-
* This is a model with one property and additionalProperties: true
709
-
*/
710
-
export type ModelWithAdditionalPropertiesEqTrue = {
711
-
/**
712
-
* This is a simple string property
713
-
*/
714
-
prop?: string;
715
-
[key: string]: unknown | string | undefined;
716
-
};
717
-
718
-
export type NestedAnyOfArraysNullable = {
719
-
nullableArray?: Array<string | boolean> | null;
720
-
};
721
-
722
-
export type CompositionWithOneOfAndProperties = ({
723
-
foo: SimpleParameter;
724
-
} | {
725
-
bar: NonAsciiStringæøåÆøÅöôêÊ字符串;
726
-
}) & {
727
-
baz: number | null;
728
-
qux: number;
729
-
};
730
-
731
-
/**
732
-
* An object that can be null
733
-
*/
734
-
export type NullableObject = {
735
-
foo?: string;
736
-
} | null;
737
-
738
-
/**
739
-
* Some % character
740
-
*/
741
-
export type CharactersInDescription = string;
742
-
743
-
export type ModelWithNullableObject = {
744
-
data?: NullableObject;
745
-
};
746
-
747
-
export type ModelWithOneOfEnum = {
748
-
foo: 'Bar';
749
-
} | {
750
-
foo: 'Baz';
751
-
} | {
752
-
foo: 'Qux';
753
-
} | {
754
-
content: string;
755
-
foo: 'Quux';
756
-
} | {
757
-
content: [
758
-
string,
759
-
string
760
-
];
761
-
foo: 'Corge';
762
-
};
763
-
764
-
export type ModelWithNestedArrayEnumsDataFoo = 'foo' | 'bar';
765
-
766
-
export type ModelWithNestedArrayEnumsDataBar = 'baz' | 'qux';
767
-
768
-
export type ModelWithNestedArrayEnumsData = {
769
-
foo?: Array<ModelWithNestedArrayEnumsDataFoo>;
770
-
bar?: Array<ModelWithNestedArrayEnumsDataBar>;
771
-
};
772
-
773
-
export type ModelWithNestedArrayEnums = {
774
-
array_strings?: Array<string>;
775
-
data?: ModelWithNestedArrayEnumsData;
776
-
};
777
-
778
-
export type ModelWithNestedCompositionEnums = {
779
-
foo?: ModelWithNestedArrayEnumsDataFoo;
780
-
};
781
-
782
-
export type ModelWithReadOnlyAndWriteOnly = {
783
-
foo: string;
784
-
readonly bar: string;
785
-
};
786
-
787
-
export type ModelWithConstantSizeArray = [
788
-
number,
789
-
number
790
-
];
791
-
792
-
export type ModelWithAnyOfConstantSizeArray = [
793
-
number | string,
794
-
number | string,
795
-
number | string
796
-
];
797
-
798
-
export type ModelWithPrefixItemsConstantSizeArray = [
799
-
ModelWithInteger,
800
-
number | string,
801
-
string
802
-
];
803
-
804
-
export type ModelWithAnyOfConstantSizeArrayNullable = [
805
-
number | null | string,
806
-
number | null | string,
807
-
number | null | string
808
-
];
809
-
810
-
export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions = [
811
-
number | Import,
812
-
number | Import
813
-
];
814
-
815
-
export type ModelWithAnyOfConstantSizeArrayAndIntersect = [
816
-
number & string,
817
-
number & string
818
-
];
819
-
820
-
export type ModelWithNumericEnumUnion = {
821
-
/**
822
-
* Период
823
-
*/
824
-
value?: -10 | -1 | 0 | 1 | 3 | 6 | 12;
825
-
};
826
-
827
-
/**
828
-
* Some description with `back ticks`
829
-
*/
830
-
export type ModelWithBackticksInDescription = {
831
-
/**
832
-
* The template `that` should be used for parsing and importing the contents of the CSV file.
833
-
*
834
-
* <br/><p>There is one placeholder currently supported:<ul> <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct JSON template:</p>
835
-
* <pre>
836
-
* [
837
-
* {
838
-
* "resourceType": "Asset",
839
-
* "identifier": {
840
-
* "name": "${1}",
841
-
* "domain": {
842
-
* "name": "${2}",
843
-
* "community": {
844
-
* "name": "Some Community"
845
-
* }
846
-
* }
847
-
* },
848
-
* "attributes" : {
849
-
* "00000000-0000-0000-0000-000000003115" : [ {
850
-
* "value" : "${3}"
851
-
* } ],
852
-
* "00000000-0000-0000-0000-000000000222" : [ {
853
-
* "value" : "${4}"
854
-
* } ]
855
-
* }
856
-
* }
857
-
* ]
858
-
* </pre>
859
-
*/
860
-
template?: string;
861
-
};
862
-
863
-
export type ModelWithOneOfAndProperties = (SimpleParameter | NonAsciiStringæøåÆøÅöôêÊ字符串) & {
864
-
baz: number | null;
865
-
qux: number;
866
-
};
867
-
868
-
/**
869
-
* Model used to test deduplication strategy (unused)
870
-
*/
871
-
export type ParameterSimpleParameterUnused = string;
872
-
873
-
/**
874
-
* Model used to test deduplication strategy
875
-
*/
876
-
export type PostServiceWithEmptyTagResponse = string;
877
-
878
-
/**
879
-
* Model used to test deduplication strategy
880
-
*/
881
-
export type PostServiceWithEmptyTagResponse2 = string;
882
-
883
-
/**
884
-
* Model used to test deduplication strategy
885
-
*/
886
-
export type DeleteFooData = string;
887
-
888
-
/**
889
-
* Model used to test deduplication strategy
890
-
*/
891
-
export type DeleteFooData2 = string;
892
-
893
-
/**
894
-
* Model with restricted keyword name
895
-
*/
896
-
export type Import = string;
897
-
898
-
export type SchemaWithFormRestrictedKeys = {
899
-
description?: string;
900
-
'x-enum-descriptions'?: string;
901
-
'x-enum-varnames'?: string;
902
-
'x-enumNames'?: string;
903
-
title?: string;
904
-
object?: {
905
-
description?: string;
906
-
'x-enum-descriptions'?: string;
907
-
'x-enum-varnames'?: string;
908
-
'x-enumNames'?: string;
909
-
title?: string;
910
-
};
911
-
array?: Array<{
912
-
description?: string;
913
-
'x-enum-descriptions'?: string;
914
-
'x-enum-varnames'?: string;
915
-
'x-enumNames'?: string;
916
-
title?: string;
917
-
}>;
918
-
};
919
-
920
-
/**
921
-
* This schema was giving PascalCase transformations a hard time
922
-
*/
923
-
export type IoK8sApimachineryPkgApisMetaV1DeleteOptions = {
924
-
/**
925
-
* Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
926
-
*/
927
-
preconditions?: IoK8sApimachineryPkgApisMetaV1Preconditions;
928
-
};
929
-
930
-
/**
931
-
* This schema was giving PascalCase transformations a hard time
932
-
*/
933
-
export type IoK8sApimachineryPkgApisMetaV1Preconditions = {
934
-
/**
935
-
* Specifies the target ResourceVersion
936
-
*/
937
-
resourceVersion?: string;
938
-
/**
939
-
* Specifies the target UID.
940
-
*/
941
-
uid?: string;
942
-
};
943
-
944
-
export type AdditionalPropertiesUnknownIssue = {
945
-
[key: string]: string | number;
946
-
};
947
-
948
-
export type AdditionalPropertiesUnknownIssue2 = {
949
-
[key: string]: string | number;
950
-
};
951
-
952
-
export type AdditionalPropertiesUnknownIssue3 = string & {
953
-
entries: {
954
-
[key: string]: AdditionalPropertiesUnknownIssue;
955
-
};
956
-
};
957
-
958
-
export type AdditionalPropertiesIntegerIssue = {
959
-
value: number;
960
-
[key: string]: number;
961
-
};
962
-
963
-
export type OneOfAllOfIssue = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString;
964
-
965
-
export type GenericSchemaDuplicateIssue1SystemBoolean = {
966
-
item?: boolean;
967
-
error?: string | null;
968
-
readonly hasError?: boolean;
969
-
data?: {
970
-
[key: string]: never;
971
-
};
972
-
};
973
-
974
-
export type GenericSchemaDuplicateIssue1SystemString = {
975
-
item?: string | null;
976
-
error?: string | null;
977
-
readonly hasError?: boolean;
978
-
};
979
-
980
-
export type ExternalSharedExternalSharedModel = {
981
-
id: string;
982
-
name?: string;
983
-
};
984
-
985
-
/**
986
-
* This is a model with one property containing a reference
987
-
*/
988
-
export type ModelWithReferenceWritable = {
989
-
prop?: ModelWithPropertiesWritable;
990
-
};
991
-
992
-
/**
993
-
* This is a model with one property containing an array
994
-
*/
995
-
export type ModelWithArrayReadOnlyAndWriteOnlyWritable = {
996
-
prop?: Array<ModelWithReadOnlyAndWriteOnlyWritable>;
997
-
propWithFile?: Array<Blob | File>;
998
-
propWithNumber?: Array<number>;
999
-
};
1000
-
1001
-
/**
1002
-
* This is a model with one nested property
1003
-
*/
1004
-
export type ModelWithPropertiesWritable = {
1005
-
required: string;
1006
-
requiredAndNullable: string | null;
1007
-
string?: string;
1008
-
number?: number;
1009
-
boolean?: boolean;
1010
-
reference?: ModelWithString;
1011
-
'property with space'?: string;
1012
-
default?: string;
1013
-
try?: string;
1014
-
};
1015
-
1016
-
/**
1017
-
* This is a model that contains a some patterns
1018
-
*/
1019
-
export type ModelWithPatternWritable = {
1020
-
key: string;
1021
-
name: string;
1022
-
id?: string;
1023
-
text?: string;
1024
-
patternWithSingleQuotes?: string;
1025
-
patternWithNewline?: string;
1026
-
patternWithBacktick?: string;
1027
-
};
1028
-
1029
-
export type FileWritable = {
1030
-
/**
1031
-
* Mime
1032
-
*/
1033
-
mime: string;
1034
-
};
1035
-
1036
-
export type ModelWithReadOnlyAndWriteOnlyWritable = {
1037
-
foo: string;
1038
-
baz: string;
1039
-
};
1040
-
1041
-
export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable = [
1042
-
number | Import,
1043
-
number | Import
1044
-
];
1045
-
1046
-
export type AdditionalPropertiesUnknownIssueWritable = {
1047
-
[key: string]: string | number;
1048
-
};
1049
-
1050
-
export type OneOfAllOfIssueWritable = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString;
1051
-
1052
-
export type GenericSchemaDuplicateIssue1SystemBooleanWritable = {
1053
-
item?: boolean;
1054
-
error?: string | null;
1055
-
data?: {
1056
-
[key: string]: never;
1057
-
};
1058
-
};
1059
-
1060
-
export type GenericSchemaDuplicateIssue1SystemStringWritable = {
1061
-
item?: string | null;
1062
-
error?: string | null;
1063
-
};
1064
-
1065
-
/**
1066
-
* This is a reusable parameter
1067
-
*/
1068
-
export type SimpleParameter = string;
1069
-
1070
-
/**
1071
-
* Parameter with illegal characters
1072
-
*/
1073
-
export type XFooBar = ModelWithString;
1074
-
1075
-
/**
1076
-
* A reusable request body
1077
-
*/
1078
-
export type SimpleRequestBody = ModelWithString;
1079
-
1080
-
/**
1081
-
* A reusable request body
1082
-
*/
1083
-
export type SimpleFormData = ModelWithString;
1084
-
1085
-
export type ExportData = {
1086
-
body?: never;
1087
-
path?: never;
1088
-
query?: never;
1089
-
url: '/api/v{api-version}/no+tag';
1090
-
};
1091
-
1092
-
export type PatchApiVbyApiVersionNoTagData = {
1093
-
body?: never;
1094
-
path?: never;
1095
-
query?: never;
1096
-
url: '/api/v{api-version}/no+tag';
1097
-
};
1098
-
1099
-
export type PatchApiVbyApiVersionNoTagResponses = {
1100
-
/**
1101
-
* OK
1102
-
*/
1103
-
default: unknown;
1104
-
};
1105
-
1106
-
export type ImportData = {
1107
-
body: ModelWithReadOnlyAndWriteOnlyWritable | ModelWithArrayReadOnlyAndWriteOnlyWritable;
1108
-
path?: never;
1109
-
query?: never;
1110
-
url: '/api/v{api-version}/no+tag';
1111
-
};
1112
-
1113
-
export type ImportResponses = {
1114
-
/**
1115
-
* Success
1116
-
*/
1117
-
200: ModelFromZendesk;
1118
-
/**
1119
-
* Default success response
1120
-
*/
1121
-
default: ModelWithReadOnlyAndWriteOnly;
1122
-
};
1123
-
1124
-
export type ImportResponse = ImportResponses[keyof ImportResponses];
1125
-
1126
-
export type FooWowData = {
1127
-
body?: never;
1128
-
path?: never;
1129
-
query?: never;
1130
-
url: '/api/v{api-version}/no+tag';
1131
-
};
1132
-
1133
-
export type FooWowResponses = {
1134
-
/**
1135
-
* OK
1136
-
*/
1137
-
default: unknown;
1138
-
};
1139
-
1140
-
export type ApiVVersionODataControllerCountData = {
1141
-
body?: never;
1142
-
path?: never;
1143
-
query?: never;
1144
-
url: '/api/v{api-version}/simple/$count';
1145
-
};
1146
-
1147
-
export type ApiVVersionODataControllerCountResponses = {
1148
-
/**
1149
-
* Success
1150
-
*/
1151
-
200: ModelFromZendesk;
1152
-
};
1153
-
1154
-
export type ApiVVersionODataControllerCountResponse = ApiVVersionODataControllerCountResponses[keyof ApiVVersionODataControllerCountResponses];
1155
-
1156
-
export type GetApiVbyApiVersionSimpleOperationData = {
1157
-
body?: never;
1158
-
path: {
1159
-
/**
1160
-
* foo in method
1161
-
*/
1162
-
foo_param: string;
1163
-
};
1164
-
query?: never;
1165
-
url: '/api/v{api-version}/simple:operation';
1166
-
};
1167
-
1168
-
export type GetApiVbyApiVersionSimpleOperationErrors = {
1169
-
/**
1170
-
* Default error response
1171
-
*/
1172
-
default: ModelWithBoolean;
1173
-
};
1174
-
1175
-
export type GetApiVbyApiVersionSimpleOperationError = GetApiVbyApiVersionSimpleOperationErrors[keyof GetApiVbyApiVersionSimpleOperationErrors];
1176
-
1177
-
export type GetApiVbyApiVersionSimpleOperationResponses = {
1178
-
/**
1179
-
* Response is a simple number
1180
-
*/
1181
-
200: number;
1182
-
};
1183
-
1184
-
export type GetApiVbyApiVersionSimpleOperationResponse = GetApiVbyApiVersionSimpleOperationResponses[keyof GetApiVbyApiVersionSimpleOperationResponses];
1185
-
1186
-
export type DeleteCallWithoutParametersAndResponseData = {
1187
-
body?: never;
1188
-
path?: never;
1189
-
query?: never;
1190
-
url: '/api/v{api-version}/simple';
1191
-
};
1192
-
1193
-
export type GetCallWithoutParametersAndResponseData = {
1194
-
body?: never;
1195
-
path?: never;
1196
-
query?: never;
1197
-
url: '/api/v{api-version}/simple';
1198
-
};
1199
-
1200
-
export type HeadCallWithoutParametersAndResponseData = {
1201
-
body?: never;
1202
-
path?: never;
1203
-
query?: never;
1204
-
url: '/api/v{api-version}/simple';
1205
-
};
1206
-
1207
-
export type OptionsCallWithoutParametersAndResponseData = {
1208
-
body?: never;
1209
-
path?: never;
1210
-
query?: never;
1211
-
url: '/api/v{api-version}/simple';
1212
-
};
1213
-
1214
-
export type PatchCallWithoutParametersAndResponseData = {
1215
-
body?: never;
1216
-
path?: never;
1217
-
query?: never;
1218
-
url: '/api/v{api-version}/simple';
1219
-
};
1220
-
1221
-
export type PostCallWithoutParametersAndResponseData = {
1222
-
body?: never;
1223
-
path?: never;
1224
-
query?: never;
1225
-
url: '/api/v{api-version}/simple';
1226
-
};
1227
-
1228
-
export type PutCallWithoutParametersAndResponseData = {
1229
-
body?: never;
1230
-
path?: never;
1231
-
query?: never;
1232
-
url: '/api/v{api-version}/simple';
1233
-
};
1234
-
1235
-
export type DeleteFooData3 = {
1236
-
body?: never;
1237
-
headers: {
1238
-
/**
1239
-
* Parameter with illegal characters
1240
-
*/
1241
-
'x-Foo-Bar': ModelWithString;
1242
-
};
1243
-
path: {
1244
-
/**
1245
-
* foo in method
1246
-
*/
1247
-
foo_param: string;
1248
-
/**
1249
-
* bar in method
1250
-
*/
1251
-
BarParam: string;
1252
-
};
1253
-
query?: never;
1254
-
url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}';
1255
-
};
1256
-
1257
-
export type CallWithDescriptionsData = {
1258
-
body?: never;
1259
-
path?: never;
1260
-
query?: {
1261
-
/**
1262
-
* Testing multiline comments in string: First line
1263
-
* Second line
1264
-
*
1265
-
* Fourth line
1266
-
*/
1267
-
parameterWithBreaks?: string;
1268
-
/**
1269
-
* Testing backticks in string: `backticks` and ```multiple backticks``` should work
1270
-
*/
1271
-
parameterWithBackticks?: string;
1272
-
/**
1273
-
* Testing slashes in string: \backwards\\\ and /forwards/// should work
1274
-
*/
1275
-
parameterWithSlashes?: string;
1276
-
/**
1277
-
* Testing expression placeholders in string: ${expression} should work
1278
-
*/
1279
-
parameterWithExpressionPlaceholders?: string;
1280
-
/**
1281
-
* Testing quotes in string: 'single quote''' and "double quotes""" should work
1282
-
*/
1283
-
parameterWithQuotes?: string;
1284
-
/**
1285
-
* Testing reserved characters in string: * inline * and ** inline ** should work
1286
-
*/
1287
-
parameterWithReservedCharacters?: string;
1288
-
};
1289
-
url: '/api/v{api-version}/descriptions';
1290
-
};
1291
-
1292
-
export type DeprecatedCallData = {
1293
-
body?: never;
1294
-
headers: {
1295
-
/**
1296
-
* This parameter is deprecated
1297
-
*
1298
-
* @deprecated
1299
-
*/
1300
-
parameter: DeprecatedModel | null;
1301
-
};
1302
-
path?: never;
1303
-
query?: never;
1304
-
url: '/api/v{api-version}/parameters/deprecated';
1305
-
};
1306
-
1307
-
export type CallWithParametersData = {
1308
-
/**
1309
-
* This is the parameter that goes into the body
1310
-
*/
1311
-
body: {
1312
-
[key: string]: unknown;
1313
-
} | null;
1314
-
headers: {
1315
-
/**
1316
-
* This is the parameter that goes into the header
1317
-
*/
1318
-
parameterHeader: string | null;
1319
-
};
1320
-
path: {
1321
-
/**
1322
-
* This is the parameter that goes into the path
1323
-
*/
1324
-
parameterPath: string | null;
1325
-
/**
1326
-
* api-version should be required in standalone clients
1327
-
*/
1328
-
'api-version': string | null;
1329
-
};
1330
-
query: {
1331
-
foo_ref_enum?: ModelWithNestedArrayEnumsDataFoo;
1332
-
foo_all_of_enum: ModelWithNestedArrayEnumsDataFoo;
1333
-
/**
1334
-
* This is the parameter that goes into the query params
1335
-
*/
1336
-
cursor: string | null;
1337
-
};
1338
-
url: '/api/v{api-version}/parameters/{parameterPath}';
1339
-
};
1340
-
1341
-
export type CallWithWeirdParameterNamesData = {
1342
-
/**
1343
-
* This is the parameter that goes into the body
1344
-
*/
1345
-
body: ModelWithString | null;
1346
-
headers: {
1347
-
/**
1348
-
* This is the parameter that goes into the request header
1349
-
*/
1350
-
'parameter.header': string | null;
1351
-
};
1352
-
path: {
1353
-
/**
1354
-
* This is the parameter that goes into the path
1355
-
*/
1356
-
'parameter.path.1'?: string;
1357
-
/**
1358
-
* This is the parameter that goes into the path
1359
-
*/
1360
-
'parameter-path-2'?: string;
1361
-
/**
1362
-
* This is the parameter that goes into the path
1363
-
*/
1364
-
'PARAMETER-PATH-3'?: string;
1365
-
/**
1366
-
* api-version should be required in standalone clients
1367
-
*/
1368
-
'api-version': string | null;
1369
-
};
1370
-
query: {
1371
-
/**
1372
-
* This is the parameter with a reserved keyword
1373
-
*/
1374
-
default?: string;
1375
-
/**
1376
-
* This is the parameter that goes into the request query params
1377
-
*/
1378
-
'parameter-query': string | null;
1379
-
};
1380
-
url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}';
1381
-
};
1382
-
1383
-
export type GetCallWithOptionalParamData = {
1384
-
/**
1385
-
* This is a required parameter
1386
-
*/
1387
-
body: ModelWithOneOfEnum;
1388
-
path?: never;
1389
-
query?: {
1390
-
/**
1391
-
* This is an optional parameter
1392
-
*/
1393
-
page?: number;
1394
-
};
1395
-
url: '/api/v{api-version}/parameters';
1396
-
};
1397
-
1398
-
export type PostCallWithOptionalParamData = {
1399
-
/**
1400
-
* This is an optional parameter
1401
-
*/
1402
-
body?: {
1403
-
offset?: number | null;
1404
-
};
1405
-
path?: never;
1406
-
query: {
1407
-
/**
1408
-
* This is a required parameter
1409
-
*/
1410
-
parameter: Pageable;
1411
-
};
1412
-
url: '/api/v{api-version}/parameters';
1413
-
};
1414
-
1415
-
export type PostCallWithOptionalParamResponses = {
1416
-
/**
1417
-
* Response is a simple number
1418
-
*/
1419
-
200: number;
1420
-
/**
1421
-
* Success
1422
-
*/
1423
-
204: void;
1424
-
};
1425
-
1426
-
export type PostCallWithOptionalParamResponse = PostCallWithOptionalParamResponses[keyof PostCallWithOptionalParamResponses];
1427
-
1428
-
export type PostApiVbyApiVersionRequestBodyData = {
1429
-
/**
1430
-
* A reusable request body
1431
-
*/
1432
-
body?: SimpleRequestBody;
1433
-
path?: never;
1434
-
query?: {
1435
-
/**
1436
-
* This is a reusable parameter
1437
-
*/
1438
-
parameter?: string;
1439
-
};
1440
-
url: '/api/v{api-version}/requestBody';
1441
-
};
1442
-
1443
-
export type PostApiVbyApiVersionFormDataData = {
1444
-
/**
1445
-
* A reusable request body
1446
-
*/
1447
-
body?: SimpleFormData;
1448
-
path?: never;
1449
-
query?: {
1450
-
/**
1451
-
* This is a reusable parameter
1452
-
*/
1453
-
parameter?: string;
1454
-
};
1455
-
url: '/api/v{api-version}/formData';
1456
-
};
1457
-
1458
-
export type CallWithDefaultParametersData = {
1459
-
body?: never;
1460
-
path?: never;
1461
-
query?: {
1462
-
/**
1463
-
* This is a simple string with default value
1464
-
*/
1465
-
parameterString?: string | null;
1466
-
/**
1467
-
* This is a simple number with default value
1468
-
*/
1469
-
parameterNumber?: number | null;
1470
-
/**
1471
-
* This is a simple boolean with default value
1472
-
*/
1473
-
parameterBoolean?: boolean | null;
1474
-
/**
1475
-
* This is a simple enum with default value
1476
-
*/
1477
-
parameterEnum?: 'Success' | 'Warning' | 'Error';
1478
-
/**
1479
-
* This is a simple model with default value
1480
-
*/
1481
-
parameterModel?: ModelWithString | null;
1482
-
};
1483
-
url: '/api/v{api-version}/defaults';
1484
-
};
1485
-
1486
-
export type CallWithDefaultOptionalParametersData = {
1487
-
body?: never;
1488
-
path?: never;
1489
-
query?: {
1490
-
/**
1491
-
* This is a simple string that is optional with default value
1492
-
*/
1493
-
parameterString?: string;
1494
-
/**
1495
-
* This is a simple number that is optional with default value
1496
-
*/
1497
-
parameterNumber?: number;
1498
-
/**
1499
-
* This is a simple boolean that is optional with default value
1500
-
*/
1501
-
parameterBoolean?: boolean;
1502
-
/**
1503
-
* This is a simple enum that is optional with default value
1504
-
*/
1505
-
parameterEnum?: 'Success' | 'Warning' | 'Error';
1506
-
/**
1507
-
* This is a simple model that is optional with default value
1508
-
*/
1509
-
parameterModel?: ModelWithString;
1510
-
};
1511
-
url: '/api/v{api-version}/defaults';
1512
-
};
1513
-
1514
-
export type CallToTestOrderOfParamsData = {
1515
-
body?: never;
1516
-
path?: never;
1517
-
query: {
1518
-
/**
1519
-
* This is a optional string with default
1520
-
*/
1521
-
parameterOptionalStringWithDefault?: string;
1522
-
/**
1523
-
* This is a optional string with empty default
1524
-
*/
1525
-
parameterOptionalStringWithEmptyDefault?: string;
1526
-
/**
1527
-
* This is a optional string with no default
1528
-
*/
1529
-
parameterOptionalStringWithNoDefault?: string;
1530
-
/**
1531
-
* This is a string with default
1532
-
*/
1533
-
parameterStringWithDefault: string;
1534
-
/**
1535
-
* This is a string with empty default
1536
-
*/
1537
-
parameterStringWithEmptyDefault: string;
1538
-
/**
1539
-
* This is a string with no default
1540
-
*/
1541
-
parameterStringWithNoDefault: string;
1542
-
/**
1543
-
* This is a string that can be null with no default
1544
-
*/
1545
-
parameterStringNullableWithNoDefault?: string | null;
1546
-
/**
1547
-
* This is a string that can be null with default
1548
-
*/
1549
-
parameterStringNullableWithDefault?: string | null;
1550
-
};
1551
-
url: '/api/v{api-version}/defaults';
1552
-
};
1553
-
1554
-
export type DuplicateNameData = {
1555
-
body?: never;
1556
-
path?: never;
1557
-
query?: never;
1558
-
url: '/api/v{api-version}/duplicate';
1559
-
};
1560
-
1561
-
export type DuplicateName2Data = {
1562
-
body?: never;
1563
-
path?: never;
1564
-
query?: never;
1565
-
url: '/api/v{api-version}/duplicate';
1566
-
};
1567
-
1568
-
export type DuplicateName3Data = {
1569
-
body?: never;
1570
-
path?: never;
1571
-
query?: never;
1572
-
url: '/api/v{api-version}/duplicate';
1573
-
};
1574
-
1575
-
export type DuplicateName4Data = {
1576
-
body?: never;
1577
-
path?: never;
1578
-
query?: never;
1579
-
url: '/api/v{api-version}/duplicate';
1580
-
};
1581
-
1582
-
export type CallWithNoContentResponseData = {
1583
-
body?: never;
1584
-
path?: never;
1585
-
query?: never;
1586
-
url: '/api/v{api-version}/no-content';
1587
-
};
1588
-
1589
-
export type CallWithNoContentResponseResponses = {
1590
-
/**
1591
-
* Success
1592
-
*/
1593
-
204: void;
1594
-
};
1595
-
1596
-
export type CallWithNoContentResponseResponse = CallWithNoContentResponseResponses[keyof CallWithNoContentResponseResponses];
1597
-
1598
-
export type CallWithResponseAndNoContentResponseData = {
1599
-
body?: never;
1600
-
path?: never;
1601
-
query?: never;
1602
-
url: '/api/v{api-version}/multiple-tags/response-and-no-content';
1603
-
};
1604
-
1605
-
export type CallWithResponseAndNoContentResponseResponses = {
1606
-
/**
1607
-
* Response is a simple number
1608
-
*/
1609
-
200: number;
1610
-
/**
1611
-
* Success
1612
-
*/
1613
-
204: void;
1614
-
};
1615
-
1616
-
export type CallWithResponseAndNoContentResponseResponse = CallWithResponseAndNoContentResponseResponses[keyof CallWithResponseAndNoContentResponseResponses];
1617
-
1618
-
export type DummyAData = {
1619
-
body?: never;
1620
-
path?: never;
1621
-
query?: never;
1622
-
url: '/api/v{api-version}/multiple-tags/a';
1623
-
};
1624
-
1625
-
export type DummyAResponses = {
1626
-
200: _400;
1627
-
};
1628
-
1629
-
export type DummyAResponse = DummyAResponses[keyof DummyAResponses];
1630
-
1631
-
export type DummyBData = {
1632
-
body?: never;
1633
-
path?: never;
1634
-
query?: never;
1635
-
url: '/api/v{api-version}/multiple-tags/b';
1636
-
};
1637
-
1638
-
export type DummyBResponses = {
1639
-
/**
1640
-
* Success
1641
-
*/
1642
-
204: void;
1643
-
};
1644
-
1645
-
export type DummyBResponse = DummyBResponses[keyof DummyBResponses];
1646
-
1647
-
export type CallWithResponseData = {
1648
-
body?: never;
1649
-
path?: never;
1650
-
query?: never;
1651
-
url: '/api/v{api-version}/response';
1652
-
};
1653
-
1654
-
export type CallWithResponseResponses = {
1655
-
default: Import;
1656
-
};
1657
-
1658
-
export type CallWithResponseResponse = CallWithResponseResponses[keyof CallWithResponseResponses];
1659
-
1660
-
export type CallWithDuplicateResponsesData = {
1661
-
body?: never;
1662
-
path?: never;
1663
-
query?: never;
1664
-
url: '/api/v{api-version}/response';
1665
-
};
1666
-
1667
-
export type CallWithDuplicateResponsesErrors = {
1668
-
/**
1669
-
* Message for 500 error
1670
-
*/
1671
-
500: ModelWithStringError;
1672
-
/**
1673
-
* Message for 501 error
1674
-
*/
1675
-
501: ModelWithStringError;
1676
-
/**
1677
-
* Message for 502 error
1678
-
*/
1679
-
502: ModelWithStringError;
1680
-
/**
1681
-
* Message for 4XX errors
1682
-
*/
1683
-
'4XX': DictionaryWithArray;
1684
-
/**
1685
-
* Default error response
1686
-
*/
1687
-
default: ModelWithBoolean;
1688
-
};
1689
-
1690
-
export type CallWithDuplicateResponsesError = CallWithDuplicateResponsesErrors[keyof CallWithDuplicateResponsesErrors];
1691
-
1692
-
export type CallWithDuplicateResponsesResponses = {
1693
-
/**
1694
-
* Message for 200 response
1695
-
*/
1696
-
200: ModelWithBoolean & ModelWithInteger;
1697
-
/**
1698
-
* Message for 201 response
1699
-
*/
1700
-
201: ModelWithString;
1701
-
/**
1702
-
* Message for 202 response
1703
-
*/
1704
-
202: ModelWithString;
1705
-
};
1706
-
1707
-
export type CallWithDuplicateResponsesResponse = CallWithDuplicateResponsesResponses[keyof CallWithDuplicateResponsesResponses];
1708
-
1709
-
export type CallWithResponsesData = {
1710
-
body?: never;
1711
-
path?: never;
1712
-
query?: never;
1713
-
url: '/api/v{api-version}/response';
1714
-
};
1715
-
1716
-
export type CallWithResponsesErrors = {
1717
-
/**
1718
-
* Message for 500 error
1719
-
*/
1720
-
500: ModelWithStringError;
1721
-
/**
1722
-
* Message for 501 error
1723
-
*/
1724
-
501: ModelWithStringError;
1725
-
/**
1726
-
* Message for 502 error
1727
-
*/
1728
-
502: ModelWithStringError;
1729
-
/**
1730
-
* Message for default response
1731
-
*/
1732
-
default: ModelWithStringError;
1733
-
};
1734
-
1735
-
export type CallWithResponsesError = CallWithResponsesErrors[keyof CallWithResponsesErrors];
1736
-
1737
-
export type CallWithResponsesResponses = {
1738
-
/**
1739
-
* Message for 200 response
1740
-
*/
1741
-
200: {
1742
-
readonly '@namespace.string'?: string;
1743
-
readonly '@namespace.integer'?: number;
1744
-
readonly value?: Array<ModelWithString>;
1745
-
};
1746
-
/**
1747
-
* Message for 201 response
1748
-
*/
1749
-
201: ModelThatExtends;
1750
-
/**
1751
-
* Message for 202 response
1752
-
*/
1753
-
202: ModelThatExtendsExtends;
1754
-
};
1755
-
1756
-
export type CallWithResponsesResponse = CallWithResponsesResponses[keyof CallWithResponsesResponses];
1757
-
1758
-
export type CollectionFormatData = {
1759
-
body?: never;
1760
-
path?: never;
1761
-
query: {
1762
-
/**
1763
-
* This is an array parameter that is sent as csv format (comma-separated values)
1764
-
*/
1765
-
parameterArrayCSV: Array<string> | null;
1766
-
/**
1767
-
* This is an array parameter that is sent as ssv format (space-separated values)
1768
-
*/
1769
-
parameterArraySSV: Array<string> | null;
1770
-
/**
1771
-
* This is an array parameter that is sent as tsv format (tab-separated values)
1772
-
*/
1773
-
parameterArrayTSV: Array<string> | null;
1774
-
/**
1775
-
* This is an array parameter that is sent as pipes format (pipe-separated values)
1776
-
*/
1777
-
parameterArrayPipes: Array<string> | null;
1778
-
/**
1779
-
* This is an array parameter that is sent as multi format (multiple parameter instances)
1780
-
*/
1781
-
parameterArrayMulti: Array<string> | null;
1782
-
};
1783
-
url: '/api/v{api-version}/collectionFormat';
1784
-
};
1785
-
1786
-
export type TypesData = {
1787
-
body?: never;
1788
-
path?: {
1789
-
/**
1790
-
* This is a number parameter
1791
-
*/
1792
-
id?: number;
1793
-
};
1794
-
query: {
1795
-
/**
1796
-
* This is a number parameter
1797
-
*/
1798
-
parameterNumber: number;
1799
-
/**
1800
-
* This is a string parameter
1801
-
*/
1802
-
parameterString: string | null;
1803
-
/**
1804
-
* This is a boolean parameter
1805
-
*/
1806
-
parameterBoolean: boolean | null;
1807
-
/**
1808
-
* This is an object parameter
1809
-
*/
1810
-
parameterObject: {
1811
-
[key: string]: unknown;
1812
-
} | null;
1813
-
/**
1814
-
* This is an array parameter
1815
-
*/
1816
-
parameterArray: Array<string> | null;
1817
-
/**
1818
-
* This is a dictionary parameter
1819
-
*/
1820
-
parameterDictionary: {
1821
-
[key: string]: unknown;
1822
-
} | null;
1823
-
/**
1824
-
* This is an enum parameter
1825
-
*/
1826
-
parameterEnum: 'Success' | 'Warning' | 'Error' | null;
1827
-
};
1828
-
url: '/api/v{api-version}/types';
1829
-
};
1830
-
1831
-
export type TypesResponses = {
1832
-
/**
1833
-
* Response is a simple number
1834
-
*/
1835
-
200: number;
1836
-
/**
1837
-
* Response is a simple string
1838
-
*/
1839
-
201: string;
1840
-
/**
1841
-
* Response is a simple boolean
1842
-
*/
1843
-
202: boolean;
1844
-
/**
1845
-
* Response is a simple object
1846
-
*/
1847
-
203: {
1848
-
[key: string]: unknown;
1849
-
};
1850
-
};
1851
-
1852
-
export type TypesResponse = TypesResponses[keyof TypesResponses];
1853
-
1854
-
export type UploadFileData = {
1855
-
body: Blob | File;
1856
-
path: {
1857
-
/**
1858
-
* api-version should be required in standalone clients
1859
-
*/
1860
-
'api-version': string | null;
1861
-
};
1862
-
query?: never;
1863
-
url: '/api/v{api-version}/upload';
1864
-
};
1865
-
1866
-
export type UploadFileResponses = {
1867
-
200: boolean;
1868
-
};
1869
-
1870
-
export type UploadFileResponse = UploadFileResponses[keyof UploadFileResponses];
1871
-
1872
-
export type FileResponseData = {
1873
-
body?: never;
1874
-
path: {
1875
-
id: string;
1876
-
/**
1877
-
* api-version should be required in standalone clients
1878
-
*/
1879
-
'api-version': string;
1880
-
};
1881
-
query?: never;
1882
-
url: '/api/v{api-version}/file/{id}';
1883
-
};
1884
-
1885
-
export type FileResponseResponses = {
1886
-
/**
1887
-
* Success
1888
-
*/
1889
-
200: Blob | File;
1890
-
};
1891
-
1892
-
export type FileResponseResponse = FileResponseResponses[keyof FileResponseResponses];
1893
-
1894
-
export type ComplexTypesData = {
1895
-
body?: never;
1896
-
path?: never;
1897
-
query: {
1898
-
/**
1899
-
* Parameter containing object
1900
-
*/
1901
-
parameterObject: {
1902
-
first?: {
1903
-
second?: {
1904
-
third?: string;
1905
-
};
1906
-
};
1907
-
};
1908
-
/**
1909
-
* Parameter containing reference
1910
-
*/
1911
-
parameterReference: ModelWithString;
1912
-
};
1913
-
url: '/api/v{api-version}/complex';
1914
-
};
1915
-
1916
-
export type ComplexTypesErrors = {
1917
-
/**
1918
-
* 400 `server` error
1919
-
*/
1920
-
400: unknown;
1921
-
/**
1922
-
* 500 server error
1923
-
*/
1924
-
500: unknown;
1925
-
};
1926
-
1927
-
export type ComplexTypesResponses = {
1928
-
/**
1929
-
* Successful response
1930
-
*/
1931
-
200: Array<ModelWithString>;
1932
-
};
1933
-
1934
-
export type ComplexTypesResponse = ComplexTypesResponses[keyof ComplexTypesResponses];
1935
-
1936
-
export type MultipartResponseData = {
1937
-
body?: never;
1938
-
path?: never;
1939
-
query?: never;
1940
-
url: '/api/v{api-version}/multipart';
1941
-
};
1942
-
1943
-
export type MultipartResponseResponses = {
1944
-
/**
1945
-
* OK
1946
-
*/
1947
-
200: {
1948
-
file?: Blob | File;
1949
-
metadata?: {
1950
-
foo?: string;
1951
-
bar?: string;
1952
-
};
1953
-
};
1954
-
};
1955
-
1956
-
export type MultipartResponseResponse = MultipartResponseResponses[keyof MultipartResponseResponses];
1957
-
1958
-
export type MultipartRequestData = {
1959
-
body?: {
1960
-
content?: Blob | File;
1961
-
data?: ModelWithString | null;
1962
-
};
1963
-
path?: never;
1964
-
query?: never;
1965
-
url: '/api/v{api-version}/multipart';
1966
-
};
1967
-
1968
-
export type ComplexParamsData = {
1969
-
body?: {
1970
-
readonly key: string | null;
1971
-
name: string | null;
1972
-
enabled?: boolean;
1973
-
type: 'Monkey' | 'Horse' | 'Bird';
1974
-
listOfModels?: Array<ModelWithString> | null;
1975
-
listOfStrings?: Array<string> | null;
1976
-
parameters: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary;
1977
-
readonly user?: {
1978
-
readonly id?: number;
1979
-
readonly name?: string | null;
1980
-
};
1981
-
};
1982
-
path: {
1983
-
id: number;
1984
-
/**
1985
-
* api-version should be required in standalone clients
1986
-
*/
1987
-
'api-version': string;
1988
-
};
1989
-
query?: never;
1990
-
url: '/api/v{api-version}/complex/{id}';
1991
-
};
1992
-
1993
-
export type ComplexParamsResponses = {
1994
-
/**
1995
-
* Success
1996
-
*/
1997
-
200: ModelWithString;
1998
-
};
1999
-
2000
-
export type ComplexParamsResponse = ComplexParamsResponses[keyof ComplexParamsResponses];
2001
-
2002
-
export type CallWithResultFromHeaderData = {
2003
-
body?: never;
2004
-
path?: never;
2005
-
query?: never;
2006
-
url: '/api/v{api-version}/header';
2007
-
};
2008
-
2009
-
export type CallWithResultFromHeaderErrors = {
2010
-
/**
2011
-
* 400 server error
2012
-
*/
2013
-
400: unknown;
2014
-
/**
2015
-
* 500 server error
2016
-
*/
2017
-
500: unknown;
2018
-
};
2019
-
2020
-
export type CallWithResultFromHeaderResponses = {
2021
-
/**
2022
-
* Successful response
2023
-
*/
2024
-
200: unknown;
2025
-
};
2026
-
2027
-
export type TestErrorCodeData = {
2028
-
body?: never;
2029
-
path?: never;
2030
-
query: {
2031
-
/**
2032
-
* Status code to return
2033
-
*/
2034
-
status: number;
2035
-
};
2036
-
url: '/api/v{api-version}/error';
2037
-
};
2038
-
2039
-
export type TestErrorCodeErrors = {
2040
-
/**
2041
-
* Custom message: Internal Server Error
2042
-
*/
2043
-
500: unknown;
2044
-
/**
2045
-
* Custom message: Not Implemented
2046
-
*/
2047
-
501: unknown;
2048
-
/**
2049
-
* Custom message: Bad Gateway
2050
-
*/
2051
-
502: unknown;
2052
-
/**
2053
-
* Custom message: Service Unavailable
2054
-
*/
2055
-
503: unknown;
2056
-
};
2057
-
2058
-
export type TestErrorCodeResponses = {
2059
-
/**
2060
-
* Custom message: Successful response
2061
-
*/
2062
-
200: unknown;
2063
-
};
2064
-
2065
-
export type NonAsciiæøåÆøÅöôêÊ字符串Data = {
2066
-
body?: never;
2067
-
path?: never;
2068
-
query: {
2069
-
/**
2070
-
* Dummy input param
2071
-
*/
2072
-
nonAsciiParamæøåÆØÅöôêÊ: number;
2073
-
};
2074
-
url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串';
2075
-
};
2076
-
2077
-
export type NonAsciiæøåÆøÅöôêÊ字符串Responses = {
2078
-
/**
2079
-
* Successful response
2080
-
*/
2081
-
200: Array<NonAsciiStringæøåÆøÅöôêÊ字符串>;
2082
-
};
2083
-
2084
-
export type NonAsciiæøåÆøÅöôêÊ字符串Response = NonAsciiæøåÆøÅöôêÊ字符串Responses[keyof NonAsciiæøåÆøÅöôêÊ字符串Responses];
2085
-
2086
-
export type PutWithFormUrlEncodedData = {
2087
-
body: ArrayWithStrings;
2088
-
path?: never;
2089
-
query?: never;
2090
-
url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串';
2091
-
};
-4
packages/openapi-ts/src/plugins/nestjs/config.ts
-4
packages/openapi-ts/src/plugins/nestjs/config.ts
···
5
5
6
6
export const defaultConfig: NestJSPlugin['Config'] = {
7
7
config: {
8
-
groupByTag: false,
9
8
includeInEntry: false,
10
9
},
11
10
dependencies: ['@hey-api/typescript'],
12
11
handler,
13
12
name: 'nestjs',
14
-
resolveConfig: (plugin) => {
15
-
plugin.config.groupByTag = plugin.config.groupByTag ?? false;
16
-
},
17
13
};
18
14
19
15
/**
+26
-47
packages/openapi-ts/src/plugins/nestjs/plugin.ts
+26
-47
packages/openapi-ts/src/plugins/nestjs/plugin.ts
···
111
111
};
112
112
113
113
export const handler: NestJSPlugin['Handler'] = ({ plugin }) => {
114
-
if (plugin.config.groupByTag) {
115
-
// Collect operations by tag, then emit per-tag types
116
-
const operationsByTag = new Map<
117
-
string,
118
-
Array<{ name: string; type: ReturnType<typeof $.type.func> }>
119
-
>();
114
+
// Collect operations by tag, then emit per-tag types
115
+
const operationsByTag = new Map<
116
+
string,
117
+
Array<{ name: string; type: ReturnType<typeof $.type.func> }>
118
+
>();
120
119
121
-
plugin.forEach(
122
-
'operation',
123
-
({ operation, tags }) => {
124
-
const tag = tags?.[0] ?? 'default';
125
-
if (!operationsByTag.has(tag)) {
126
-
operationsByTag.set(tag, []);
127
-
}
128
-
const method = operationToMethod({ operation, plugin });
129
-
operationsByTag.get(tag)!.push(method);
130
-
},
131
-
{
132
-
order: 'declarations',
133
-
},
134
-
);
120
+
plugin.forEach(
121
+
'operation',
122
+
({ operation, tags }) => {
123
+
const tag = tags?.[0] ?? 'default';
124
+
if (!operationsByTag.has(tag)) {
125
+
operationsByTag.set(tag, []);
126
+
}
127
+
const method = operationToMethod({ operation, plugin });
128
+
operationsByTag.get(tag)!.push(method);
129
+
},
130
+
{
131
+
order: 'declarations',
132
+
},
133
+
);
135
134
136
-
for (const [tag, methods] of operationsByTag) {
137
-
const pascalTag = toCase(tag, 'PascalCase');
138
-
emitTypeAlias({
139
-
methods,
140
-
plugin,
141
-
typeName: `${pascalTag}ControllerMethods`,
142
-
});
143
-
}
144
-
} else {
145
-
// Flat mode: single ControllerMethods
146
-
const methods: Array<{
147
-
name: string;
148
-
type: ReturnType<typeof $.type.func>;
149
-
}> = [];
150
-
151
-
plugin.forEach(
152
-
'operation',
153
-
({ operation }) => {
154
-
const method = operationToMethod({ operation, plugin });
155
-
methods.push(method);
156
-
},
157
-
{
158
-
order: 'declarations',
159
-
},
160
-
);
161
-
162
-
emitTypeAlias({ methods, plugin, typeName: 'ControllerMethods' });
135
+
for (const [tag, methods] of operationsByTag) {
136
+
const pascalTag = toCase(tag, 'PascalCase');
137
+
emitTypeAlias({
138
+
methods,
139
+
plugin,
140
+
typeName: `${pascalTag}ControllerMethods`,
141
+
});
163
142
}
164
143
};
+2
-19
packages/openapi-ts/src/plugins/nestjs/types.ts
+2
-19
packages/openapi-ts/src/plugins/nestjs/types.ts
···
1
1
import type { DefinePlugin, Plugin } from '@hey-api/shared';
2
2
3
-
export type UserConfig = Plugin.Name<'nestjs'> &
4
-
Plugin.Hooks &
5
-
Plugin.UserExports & {
6
-
/**
7
-
* Group controller methods by OpenAPI tag.
8
-
* When true, generates per-tag types like `PetsControllerMethods`.
9
-
* When false (default), generates flat `ControllerMethods`.
10
-
*
11
-
* @default false
12
-
*/
13
-
groupByTag?: boolean;
14
-
};
3
+
export type UserConfig = Plugin.Name<'nestjs'> & Plugin.Hooks & Plugin.UserExports;
15
4
16
-
export type Config = Plugin.Name<'nestjs'> &
17
-
Plugin.Hooks &
18
-
Plugin.Exports & {
19
-
groupByTag: boolean;
20
-
};
21
-
22
-
export type NestJSPlugin = DefinePlugin<UserConfig, Config>;
5
+
export type NestJSPlugin = DefinePlugin<UserConfig, UserConfig>;