fork of hey-api/openapi-ts because I need some additional things
Merge pull request #1471 from hey-api/fix/client-descriptions
fix: add links to the experimental parser callouts
+52
-9
+7
.changeset/lovely-lies-impress.md
+7
.changeset/lovely-lies-impress.md
+6
packages/client-axios/src/types.ts
+6
packages/client-axios/src/types.ts
···
17
17
export interface Config<ThrowOnError extends boolean = boolean>
18
18
extends Omit<CreateAxiosDefaults, 'headers'> {
19
19
/**
20
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
21
+
*
20
22
* Access token or a function returning access token. The resolved token will
21
23
* be added to request payload as required.
22
24
*/
23
25
accessToken?: (() => Promise<string | undefined>) | string | undefined;
24
26
/**
27
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
28
+
*
25
29
* API key or a function returning API key. The resolved key will be added
26
30
* to the request payload as required.
27
31
*/
···
88
92
*/
89
93
responseTransformer?: (data: unknown) => Promise<unknown>;
90
94
/**
95
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
96
+
*
91
97
* A function validating response data. This is useful if you want to ensure
92
98
* the response conforms to the desired shape, so it can be safely passed to
93
99
* the transformers and returned to the user.
+6
packages/client-fetch/src/types.ts
+6
packages/client-fetch/src/types.ts
···
10
10
export interface Config<ThrowOnError extends boolean = boolean>
11
11
extends Omit<RequestInit, 'body' | 'headers' | 'method'> {
12
12
/**
13
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
14
+
*
13
15
* Access token or a function returning access token. The resolved token
14
16
* will be added to request headers where it's required.
15
17
*/
16
18
accessToken?: (() => Promise<string | undefined>) | string | undefined;
17
19
/**
20
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
21
+
*
18
22
* API key or a function returning API key. The resolved key will be added
19
23
* to the request payload as required.
20
24
*/
···
93
97
*/
94
98
responseTransformer?: (data: unknown) => Promise<unknown>;
95
99
/**
100
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
101
+
*
96
102
* A function validating response data. This is useful if you want to ensure
97
103
* the response conforms to the desired shape, so it can be safely passed to
98
104
* the transformers and returned to the user.
+2
-2
packages/openapi-ts/src/plugins/@hey-api/sdk/types.d.ts
+2
-2
packages/openapi-ts/src/plugins/@hey-api/sdk/types.d.ts
···
16
16
*/
17
17
asClass?: boolean;
18
18
/**
19
-
* **This feature works only with the experimental parser**
19
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
20
20
*
21
21
* Should the generated functions contain auth mechanisms? You may want to
22
22
* disable this option if you're handling auth yourself or defining it
···
90
90
*/
91
91
transformer?: '@hey-api/transformers' | boolean;
92
92
/**
93
-
* **This feature works only with the experimental parser**
93
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
94
94
*
95
95
* Validate response data against schema before returning. This is useful
96
96
* if you want to ensure the response conforms to a desired shape. However,
+3
-3
packages/openapi-ts/src/plugins/@hey-api/typescript/types.d.ts
+3
-3
packages/openapi-ts/src/plugins/@hey-api/typescript/types.d.ts
···
11
11
*/
12
12
enums?: 'javascript' | 'typescript' | 'typescript+namespace' | false;
13
13
/**
14
-
* **This feature works only with the experimental parser**
14
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
15
15
*
16
16
* Defines casing of the enum keys. By default, we use `SCREAMING_SNAKE_CASE`.
17
17
* This option has effect only when `enums` is defined.
···
20
20
*/
21
21
enumsCase?: StringCase;
22
22
/**
23
-
* **This feature works only with the experimental parser**
23
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
24
24
*
25
25
* By default, inline enums (enums not defined as reusable components in
26
26
* the input file) are generated as inlined union types. You can set
···
31
31
*/
32
32
exportInlineEnums?: boolean;
33
33
/**
34
-
* **This feature works only with the experimental parser**
34
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
35
35
*
36
36
* Defines casing of the identifiers. By default, we use `PascalCase`.
37
37
*
+1
-1
packages/openapi-ts/src/plugins/types.d.ts
+1
-1
packages/openapi-ts/src/plugins/types.d.ts
···
32
32
33
33
interface BaseConfig {
34
34
/**
35
-
* **This feature works only with the experimental parser**
35
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
36
36
*
37
37
* Should the exports from the plugin's file be re-exported in the index
38
38
* barrel file?
+3
-3
packages/openapi-ts/src/types/config.ts
+3
-3
packages/openapi-ts/src/types/config.ts
···
81
81
| Record<string, unknown>
82
82
| {
83
83
/**
84
-
* **This feature works only with the experimental parser**
84
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
85
85
*
86
86
* Prevent parts matching the regular expression from being processed.
87
87
* You can select both operations and components by reference within
···
94
94
*/
95
95
exclude?: string;
96
96
/**
97
-
* **This feature works only with the experimental parser**
97
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
98
98
*
99
99
* Process only parts matching the regular expression. You can select both
100
100
* operations and components by reference within the bundled input. In
···
159
159
| string
160
160
| {
161
161
/**
162
-
* **This feature works only with the experimental parser**
162
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
163
163
*
164
164
* Defines casing of the output fields. By default, we preserve `input`
165
165
* values as data transforms incur a performance penalty at runtime.
+6
packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios-bundle/client/types.ts.snap
+6
packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios-bundle/client/types.ts.snap
···
17
17
export interface Config<ThrowOnError extends boolean = boolean>
18
18
extends Omit<CreateAxiosDefaults, 'headers'> {
19
19
/**
20
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
21
+
*
20
22
* Access token or a function returning access token. The resolved token will
21
23
* be added to request payload as required.
22
24
*/
23
25
accessToken?: (() => Promise<string | undefined>) | string | undefined;
24
26
/**
27
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
28
+
*
25
29
* API key or a function returning API key. The resolved key will be added
26
30
* to the request payload as required.
27
31
*/
···
88
92
*/
89
93
responseTransformer?: (data: unknown) => Promise<unknown>;
90
94
/**
95
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
96
+
*
91
97
* A function validating response data. This is useful if you want to ensure
92
98
* the response conforms to the desired shape, so it can be safely passed to
93
99
* the transformers and returned to the user.
+6
packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios-bundle_transform/client/types.ts.snap
+6
packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios-bundle_transform/client/types.ts.snap
···
17
17
export interface Config<ThrowOnError extends boolean = boolean>
18
18
extends Omit<CreateAxiosDefaults, 'headers'> {
19
19
/**
20
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
21
+
*
20
22
* Access token or a function returning access token. The resolved token will
21
23
* be added to request payload as required.
22
24
*/
23
25
accessToken?: (() => Promise<string | undefined>) | string | undefined;
24
26
/**
27
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
28
+
*
25
29
* API key or a function returning API key. The resolved key will be added
26
30
* to the request payload as required.
27
31
*/
···
88
92
*/
89
93
responseTransformer?: (data: unknown) => Promise<unknown>;
90
94
/**
95
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
96
+
*
91
97
* A function validating response data. This is useful if you want to ensure
92
98
* the response conforms to the desired shape, so it can be safely passed to
93
99
* the transformers and returned to the user.
+6
packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-bundle/client/types.ts.snap
+6
packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-bundle/client/types.ts.snap
···
10
10
export interface Config<ThrowOnError extends boolean = boolean>
11
11
extends Omit<RequestInit, 'body' | 'headers' | 'method'> {
12
12
/**
13
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
14
+
*
13
15
* Access token or a function returning access token. The resolved token
14
16
* will be added to request headers where it's required.
15
17
*/
16
18
accessToken?: (() => Promise<string | undefined>) | string | undefined;
17
19
/**
20
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
21
+
*
18
22
* API key or a function returning API key. The resolved key will be added
19
23
* to the request payload as required.
20
24
*/
···
93
97
*/
94
98
responseTransformer?: (data: unknown) => Promise<unknown>;
95
99
/**
100
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
101
+
*
96
102
* A function validating response data. This is useful if you want to ensure
97
103
* the response conforms to the desired shape, so it can be safely passed to
98
104
* the transformers and returned to the user.
+6
packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-bundle_transform/client/types.ts.snap
+6
packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-bundle_transform/client/types.ts.snap
···
10
10
export interface Config<ThrowOnError extends boolean = boolean>
11
11
extends Omit<RequestInit, 'body' | 'headers' | 'method'> {
12
12
/**
13
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
14
+
*
13
15
* Access token or a function returning access token. The resolved token
14
16
* will be added to request headers where it's required.
15
17
*/
16
18
accessToken?: (() => Promise<string | undefined>) | string | undefined;
17
19
/**
20
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
21
+
*
18
22
* API key or a function returning API key. The resolved key will be added
19
23
* to the request payload as required.
20
24
*/
···
93
97
*/
94
98
responseTransformer?: (data: unknown) => Promise<unknown>;
95
99
/**
100
+
* **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
101
+
*
96
102
* A function validating response data. This is useful if you want to ensure
97
103
* the response conforms to the desired shape, so it can be safely passed to
98
104
* the transformers and returned to the user.