fix: docs about wrong Badge usage, wrong import line example

kubb-labs · Oct 18, 2023 · ed36922 · ed36922
1 parent a277ff0
commit ed36922
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 9 deletions.
diff --git a/docs/plugins/swagger-client/index.md b/docs/plugins/swagger-client/index.md
@@ -63,7 +63,7 @@ Name to be used for the `export * as {{exportAs}} from './`
 Type: `string` <br/>
 Default: `"{{tag}}Service"`
 
-### client <Badge type="error" text="deprecated" />
+### client <Badge type="danger" text="deprecated" />
 Path to the client that will be used to do the API calls.
 Relative to the root
 
@@ -74,7 +74,7 @@ Deprecated. Use `clientImportPath` instead. It will be skipped if `clientImportP
 
 ### clientImportPath
 Path to the client import path that will be used to do the API calls.
-It will be used as `import { client } from '{{clientImportPath}}'`.
+It will be used as `import client from '${clientImportPath}'`.
 It allow both relative and absolute path. the path will be applied as is,
 so relative path shoule be based on the file being generated.
 

diff --git a/docs/plugins/swagger-swr.md b/docs/plugins/swagger-swr.md
@@ -62,7 +62,7 @@ Name to be used for the `export * as {{exportAs}} from './`
 Type: `string` <br/>
 Default: `"{{tag}}SWRHooks"`
 
-### client <Badge type="error" text="deprecated" />
+### client <Badge type="danger" text="deprecated" />
 Path to the client that will be used to do the API calls.
 Relative to the root
 
@@ -73,7 +73,7 @@ Deprecated. Use `clientImportPath` instead. It will be skipped if `clientImportP
 
 ### clientImportPath
 Path to the client import path that will be used to do the API calls.
-It will be used as `import { client } from '{{clientImportPath}}'`.
+It will be used as `import client from '${clientImportPath}'`.
 It allow both relative and absolute path. the path will be applied as is,
 so relative path shoule be based on the file being generated.
 

diff --git a/docs/plugins/swagger-tanstack-query.md b/docs/plugins/swagger-tanstack-query.md
@@ -68,7 +68,7 @@ Name to be used for the `export * as {{exportAs}} from './`
 Type: `string` <br/>
 Default: `"{{tag}}Hooks"`
 
-### client <Badge type="error" text="deprecated" />
+### client <Badge type="danger" text="deprecated" />
 Path to the client that will be used to do the API calls.
 Relative to the root
 
@@ -79,7 +79,7 @@ Deprecated. Use `clientImportPath` instead. It will be skipped if `clientImportP
 
 ### clientImportPath
 Path to the client import path that will be used to do the API calls.
-It will be used as `import { client } from '{{clientImportPath}}'`.
+It will be used as `import client from '${clientImportPath}'`.
 It allow both relative and absolute path. the path will be applied as is,
 so relative path shoule be based on the file being generated.
 

diff --git a/packages/swagger-client/src/types.ts b/packages/swagger-client/src/types.ts
@@ -61,7 +61,7 @@ export type Options = {
   client?: string
   /**
    * Path to the client import path that will be used to do the API calls.
-   * It will be used as `import { client } from '{{clientImportPath}}'`.
+   * It will be used as `import client from '${clientImportPath}'`.
    * It allow both relative and absolute path.
    * the path will be applied as is, so relative path shoule be based on the file being generated.
    * @default '@kubb/swagger-client/client'

diff --git a/packages/swagger-swr/src/types.ts b/packages/swagger-swr/src/types.ts
@@ -39,7 +39,7 @@ export type Options = {
   client?: string
   /**
    * Path to the client import path that will be used to do the API calls.
-   * It will be used as `import { client } from '{{clientImportPath}}'`.
+   * It will be used as `import client from '${clientImportPath}'`.
    * It allow both relative and absolute path.
    * the path will be applied as is, so relative path shoule be based on the file being generated.
    * @default '@kubb/swagger-client/client'

diff --git a/packages/swagger-tanstack-query/src/types.ts b/packages/swagger-tanstack-query/src/types.ts
@@ -32,7 +32,7 @@ export type Options = {
   client?: string
   /**
    * Path to the client import path that will be used to do the API calls.
-   * It will be used as `import { client } from '{{clientImportPath}}'`.
+   * It will be used as `import client from '${clientImportPath}'`.
    * It allow both relative and absolute path.
    * the path will be applied as is, so relative path shoule be based on the file being generated.
    * @default '@kubb/swagger-client/client'