Merge pull request #1471 from hey-api/fix/client-descriptions

fix: add links to the experimental parser callouts

.changeset/lovely-lies-impress.md

@@ -0,0 +1,7 @@
+---
+'@hey-api/client-axios': patch
+'@hey-api/client-fetch': patch
+'@hey-api/openapi-ts': patch
+---
+
+fix: add links to the experimental parser callouts

packages/client-axios/src/types.ts

@@ -17,11 +17,15 @@ type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
 export interface Config<ThrowOnError extends boolean = boolean>
   extends Omit<CreateAxiosDefaults, 'headers'> {
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * Access token or a function returning access token. The resolved token will
    * be added to request payload as required.
    */
   accessToken?: (() => Promise<string | undefined>) | string | undefined;
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * API key or a function returning API key. The resolved key will be added
    * to the request payload as required.
    */
@@ -88,6 +92,8 @@ export interface Config<ThrowOnError extends boolean = boolean>
    */
   responseTransformer?: (data: unknown) => Promise<unknown>;
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * A function validating response data. This is useful if you want to ensure
    * the response conforms to the desired shape, so it can be safely passed to
    * the transformers and returned to the user.

packages/client-fetch/src/types.ts

@@ -10,11 +10,15 @@ type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
 export interface Config<ThrowOnError extends boolean = boolean>
   extends Omit<RequestInit, 'body' | 'headers' | 'method'> {
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * Access token or a function returning access token. The resolved token
    * will be added to request headers where it's required.
    */
   accessToken?: (() => Promise<string | undefined>) | string | undefined;
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * API key or a function returning API key. The resolved key will be added
    * to the request payload as required.
    */
@@ -93,6 +97,8 @@ export interface Config<ThrowOnError extends boolean = boolean>
    */
   responseTransformer?: (data: unknown) => Promise<unknown>;
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * A function validating response data. This is useful if you want to ensure
    * the response conforms to the desired shape, so it can be safely passed to
    * the transformers and returned to the user.

packages/openapi-ts/src/plugins/@hey-api/sdk/types.d.ts

@@ -16,7 +16,7 @@ export interface Config extends Plugin.Name<'@hey-api/sdk'> {
    */
   asClass?: boolean;
   /**
-   * **This feature works only with the experimental parser**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
    *
    * Should the generated functions contain auth mechanisms? You may want to
    * disable this option if you're handling auth yourself or defining it
@@ -90,7 +90,7 @@ export interface Config extends Plugin.Name<'@hey-api/sdk'> {
    */
   transformer?: '@hey-api/transformers' | boolean;
   /**
-   * **This feature works only with the experimental parser**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
    *
    * Validate response data against schema before returning. This is useful
    * if you want to ensure the response conforms to a desired shape. However,

packages/openapi-ts/src/plugins/@hey-api/typescript/types.d.ts

@@ -11,7 +11,7 @@ export interface Config extends Plugin.Name<'@hey-api/typescript'> {
    */
   enums?: 'javascript' | 'typescript' | 'typescript+namespace' | false;
   /**
-   * **This feature works only with the experimental parser**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
    *
    * Defines casing of the enum keys. By default, we use `SCREAMING_SNAKE_CASE`.
    * This option has effect only when `enums` is defined.
@@ -20,7 +20,7 @@ export interface Config extends Plugin.Name<'@hey-api/typescript'> {
    */
   enumsCase?: StringCase;
   /**
-   * **This feature works only with the experimental parser**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
    *
    * By default, inline enums (enums not defined as reusable components in
    * the input file) are generated as inlined union types. You can set
@@ -31,7 +31,7 @@ export interface Config extends Plugin.Name<'@hey-api/typescript'> {
    */
   exportInlineEnums?: boolean;
   /**
-   * **This feature works only with the experimental parser**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
    *
    * Defines casing of the identifiers. By default, we use `PascalCase`.
    *

packages/openapi-ts/src/plugins/types.d.ts

@@ -32,7 +32,7 @@ export interface PluginContext {
 
 interface BaseConfig {
   /**
-   * **This feature works only with the experimental parser**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
    *
    * Should the exports from the plugin's file be re-exported in the index
    * barrel file?

packages/openapi-ts/src/types/config.ts

@@ -81,7 +81,7 @@ export interface ClientConfig {
     | Record<string, unknown>
     | {
         /**
-         * **This feature works only with the experimental parser**
+         * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
          *
          * Prevent parts matching the regular expression from being processed.
          * You can select both operations and components by reference within
@@ -94,7 +94,7 @@ export interface ClientConfig {
          */
         exclude?: string;
         /**
-         * **This feature works only with the experimental parser**
+         * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
          *
          * Process only parts matching the regular expression. You can select both
          * operations and components by reference within the bundled input. In
@@ -159,7 +159,7 @@ export interface ClientConfig {
     | string
     | {
         /**
-         * **This feature works only with the experimental parser**
+         * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
          *
          * Defines casing of the output fields. By default, we preserve `input`
          * values as data transforms incur a performance penalty at runtime.

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios-bundle/client/types.ts.snap

@@ -17,11 +17,15 @@ type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
 export interface Config<ThrowOnError extends boolean = boolean>
   extends Omit<CreateAxiosDefaults, 'headers'> {
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * Access token or a function returning access token. The resolved token will
    * be added to request payload as required.
    */
   accessToken?: (() => Promise<string | undefined>) | string | undefined;
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * API key or a function returning API key. The resolved key will be added
    * to the request payload as required.
    */
@@ -88,6 +92,8 @@ export interface Config<ThrowOnError extends boolean = boolean>
    */
   responseTransformer?: (data: unknown) => Promise<unknown>;
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * A function validating response data. This is useful if you want to ensure
    * the response conforms to the desired shape, so it can be safely passed to
    * the transformers and returned to the user.

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios-bundle_transform/client/types.ts.snap

@@ -17,11 +17,15 @@ type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
 export interface Config<ThrowOnError extends boolean = boolean>
   extends Omit<CreateAxiosDefaults, 'headers'> {
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * Access token or a function returning access token. The resolved token will
    * be added to request payload as required.
    */
   accessToken?: (() => Promise<string | undefined>) | string | undefined;
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * API key or a function returning API key. The resolved key will be added
    * to the request payload as required.
    */
@@ -88,6 +92,8 @@ export interface Config<ThrowOnError extends boolean = boolean>
    */
   responseTransformer?: (data: unknown) => Promise<unknown>;
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * A function validating response data. This is useful if you want to ensure
    * the response conforms to the desired shape, so it can be safely passed to
    * the transformers and returned to the user.

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-bundle/client/types.ts.snap

@@ -10,11 +10,15 @@ type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
 export interface Config<ThrowOnError extends boolean = boolean>
   extends Omit<RequestInit, 'body' | 'headers' | 'method'> {
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * Access token or a function returning access token. The resolved token
    * will be added to request headers where it's required.
    */
   accessToken?: (() => Promise<string | undefined>) | string | undefined;
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * API key or a function returning API key. The resolved key will be added
    * to the request payload as required.
    */
@@ -93,6 +97,8 @@ export interface Config<ThrowOnError extends boolean = boolean>
    */
   responseTransformer?: (data: unknown) => Promise<unknown>;
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * A function validating response data. This is useful if you want to ensure
    * the response conforms to the desired shape, so it can be safely passed to
    * the transformers and returned to the user.

packages/openapi-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-bundle_transform/client/types.ts.snap

@@ -10,11 +10,15 @@ type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
 export interface Config<ThrowOnError extends boolean = boolean>
   extends Omit<RequestInit, 'body' | 'headers' | 'method'> {
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * Access token or a function returning access token. The resolved token
    * will be added to request headers where it's required.
    */
   accessToken?: (() => Promise<string | undefined>) | string | undefined;
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * API key or a function returning API key. The resolved key will be added
    * to the request payload as required.
    */
@@ -93,6 +97,8 @@ export interface Config<ThrowOnError extends boolean = boolean>
    */
   responseTransformer?: (data: unknown) => Promise<unknown>;
   /**
+   * **This feature works only with the [experimental parser](https://heyapi.dev/openapi-ts/configuration#parser)**
+   *
    * A function validating response data. This is useful if you want to ensure
    * the response conforms to the desired shape, so it can be safely passed to
    * the transformers and returned to the user.