Skip to content

Commit

Permalink
fix(docs): fix typo parameters (#728)
Browse files Browse the repository at this point in the history
  • Loading branch information
chiptus authored Dec 14, 2023
1 parent c8d4ead commit 72a1efb
Show file tree
Hide file tree
Showing 193 changed files with 585 additions and 585 deletions.
6 changes: 3 additions & 3 deletions docs/plugins/swagger-client/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@ export default defineConfig({

### include

Array containing include paramaters to include tags/operations/methods/paths.
Array containing include parameters to include tags/operations/methods/paths.

::: info type

Expand Down Expand Up @@ -502,7 +502,7 @@ export default defineConfig({

### exclude

Array containing exclude paramaters to exclude/skip tags/operations/methods/paths.
Array containing exclude parameters to exclude/skip tags/operations/methods/paths.

::: info type

Expand Down Expand Up @@ -555,7 +555,7 @@ export default defineConfig({

### override

Array containing override paramaters to override `options` based on tags/operations/methods/paths.
Array containing override parameters to override `options` based on tags/operations/methods/paths.

::: info type

Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/swagger-faker/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ export default defineConfig({

### include

Array containing include paramaters to include tags/operations/methods/paths.
Array containing include parameters to include tags/operations/methods/paths.

::: info type

Expand Down Expand Up @@ -285,7 +285,7 @@ export default defineConfig({

### exclude

Array containing exclude paramaters to exclude/skip tags/operations/methods/paths.
Array containing exclude parameters to exclude/skip tags/operations/methods/paths.

::: info type

Expand Down Expand Up @@ -338,7 +338,7 @@ export default defineConfig({

### override

Array containing override paramaters to override `options` based on tags/operations/methods/paths.
Array containing override parameters to override `options` based on tags/operations/methods/paths.

::: info type

Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/swagger-msw/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ export default defineConfig({

### include

Array containing include paramaters to include tags/operations/methods/paths.
Array containing include parameters to include tags/operations/methods/paths.

::: info type

Expand Down Expand Up @@ -299,7 +299,7 @@ export default defineConfig({

### exclude

Array containing exclude paramaters to exclude/skip tags/operations/methods/paths.
Array containing exclude parameters to exclude/skip tags/operations/methods/paths.

::: info type

Expand Down Expand Up @@ -354,7 +354,7 @@ export default defineConfig({

### override

Array containing override paramaters to override `options` based on tags/operations/methods/paths.
Array containing override parameters to override `options` based on tags/operations/methods/paths.

::: info type

Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/swagger-swr/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ export default defineConfig({

### include

Array containing include paramaters to include tags/operations/methods/paths.
Array containing include parameters to include tags/operations/methods/paths.

::: info type

Expand Down Expand Up @@ -414,7 +414,7 @@ export default defineConfig({

### exclude

Array containing exclude paramaters to exclude/skip tags/operations/methods/paths.
Array containing exclude parameters to exclude/skip tags/operations/methods/paths.

::: info type

Expand Down Expand Up @@ -467,7 +467,7 @@ export default defineConfig({

### override

Array containing override paramaters to override `options` based on tags/operations/methods/paths.
Array containing override parameters to override `options` based on tags/operations/methods/paths.

::: info type

Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/swagger-tanstack-query/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -578,7 +578,7 @@ export default defineConfig({

### include

Array containing include paramaters to include tags/operations/methods/paths.
Array containing include parameters to include tags/operations/methods/paths.

::: info type

Expand Down Expand Up @@ -631,7 +631,7 @@ export default defineConfig({

### exclude

Array containing exclude paramaters to exclude/skip tags/operations/methods/paths.
Array containing exclude parameters to exclude/skip tags/operations/methods/paths.

::: info type

Expand Down Expand Up @@ -684,7 +684,7 @@ export default defineConfig({

### override

Array containing override paramaters to override `options` based on tags/operations/methods/paths.
Array containing override parameters to override `options` based on tags/operations/methods/paths.

::: info type

Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/swagger-ts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ export default defineConfig({

### include

Array containing include paramaters to include tags/operations/methods/paths.
Array containing include parameters to include tags/operations/methods/paths.

::: info type

Expand Down Expand Up @@ -521,7 +521,7 @@ export default defineConfig({

### exclude

Array containing exclude paramaters to exclude/skip tags/operations/methods/paths.
Array containing exclude parameters to exclude/skip tags/operations/methods/paths.

::: info type

Expand Down Expand Up @@ -572,7 +572,7 @@ export default defineConfig({

### override

Array containing override paramaters to override `options` based on tags/operations/methods/paths.
Array containing override parameters to override `options` based on tags/operations/methods/paths.

::: info type

Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/swagger-zod/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ export default defineConfig({

### include

Array containing include paramaters to include tags/operations/methods/paths.
Array containing include parameters to include tags/operations/methods/paths.

::: info type

Expand Down Expand Up @@ -191,7 +191,7 @@ export default defineConfig({

### exclude

Array containing exclude paramaters to exclude/skip tags/operations/methods/paths.
Array containing exclude parameters to exclude/skip tags/operations/methods/paths.

::: info type

Expand Down Expand Up @@ -242,7 +242,7 @@ export default defineConfig({

### override

Array containing override paramaters to override `options` based on tags/operations/methods/paths.
Array containing override parameters to override `options` based on tags/operations/methods/paths.

::: info type

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ type AddPet = {
headerParams: never
response: Awaited<ReturnType<AddPetClient>>
client: {
paramaters: Partial<Parameters<AddPetClient>[0]>
parameters: Partial<Parameters<AddPetClient>[0]>
return: Awaited<ReturnType<AddPetClient>>
}
}
Expand All @@ -23,7 +23,7 @@ type AddPet = {
* @link /pet */
export function useAddPet(options: {
mutation?: UseMutationOptions<AddPet['response'], AddPet['error'], AddPet['request']>
client?: AddPet['client']['paramaters']
client?: AddPet['client']['parameters']
} = {}): UseMutationResult<AddPet['response'], AddPet['error'], AddPet['request']> {
const { mutation: mutationOptions, client: clientOptions = {} } = options ?? {}
return useMutation<AddPet['response'], AddPet['error'], AddPet['request']>({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ type DeletePet = {
headerParams: DeletePetHeaderParams
response: Awaited<ReturnType<DeletePetClient>>
client: {
paramaters: Partial<Parameters<DeletePetClient>[0]>
parameters: Partial<Parameters<DeletePetClient>[0]>
return: Awaited<ReturnType<DeletePetClient>>
}
}
Expand All @@ -23,7 +23,7 @@ type DeletePet = {
* @link /pet/:petId */
export function useDeletePet(petId: DeletePetPathParams['petId'], headers?: DeletePet['headerParams'], options: {
mutation?: UseMutationOptions<DeletePet['response'], DeletePet['error'], void>
client?: DeletePet['client']['paramaters']
client?: DeletePet['client']['parameters']
} = {}): UseMutationResult<DeletePet['response'], DeletePet['error'], void> {
const { mutation: mutationOptions, client: clientOptions = {} } = options ?? {}
return useMutation<DeletePet['response'], DeletePet['error'], void>({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ type FindPetsByStatus = {
headerParams: never
response: Awaited<ReturnType<FindPetsByStatusClient>>
client: {
paramaters: Partial<Parameters<FindPetsByStatusClient>[0]>
parameters: Partial<Parameters<FindPetsByStatusClient>[0]>
return: Awaited<ReturnType<FindPetsByStatusClient>>
}
}
Expand All @@ -26,7 +26,7 @@ export function findPetsByStatusQueryOptions<
TQueryData = FindPetsByStatus['response'],
>(
params?: FindPetsByStatus['queryParams'],
options: FindPetsByStatus['client']['paramaters'] = {},
options: FindPetsByStatus['client']['parameters'] = {},
): WithRequired<UseBaseQueryOptions<FindPetsByStatus['response'], TError, TData, TQueryData>, 'queryKey'> {
const queryKey = findPetsByStatusQueryKey(params)
return {
Expand Down Expand Up @@ -54,7 +54,7 @@ export function useFindPetsByStatus<
TQueryKey extends QueryKey = FindPetsByStatusQueryKey,
>(params?: FindPetsByStatus['queryParams'], options: {
query?: UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
client?: FindPetsByStatus['client']['paramaters']
client?: FindPetsByStatus['client']['parameters']
} = {}): UseQueryResult<TData, TError> & {
queryKey: TQueryKey
} {
Expand All @@ -80,7 +80,7 @@ export function findPetsByStatusInfiniteQueryOptions<
TQueryData = FindPetsByStatus['response'],
>(
params?: FindPetsByStatus['queryParams'],
options: FindPetsByStatus['client']['paramaters'] = {},
options: FindPetsByStatus['client']['parameters'] = {},
): WithRequired<UseInfiniteQueryOptions<FindPetsByStatus['response'], TError, TData, TQueryData>, 'queryKey'> {
const queryKey = findPetsByStatusInfiniteQueryKey(params)
return {
Expand Down Expand Up @@ -112,7 +112,7 @@ export function useFindPetsByStatusInfinite<
TQueryKey extends QueryKey = FindPetsByStatusInfiniteQueryKey,
>(params?: FindPetsByStatus['queryParams'], options: {
query?: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
client?: FindPetsByStatus['client']['paramaters']
client?: FindPetsByStatus['client']['parameters']
} = {}): UseInfiniteQueryResult<TData, TError> & {
queryKey: TQueryKey
} {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ type FindPetsByTags = {
headerParams: FindPetsByTagsHeaderParams
response: Awaited<ReturnType<FindPetsByTagsClient>>
client: {
paramaters: Partial<Parameters<FindPetsByTagsClient>[0]>
parameters: Partial<Parameters<FindPetsByTagsClient>[0]>
return: Awaited<ReturnType<FindPetsByTagsClient>>
}
}
Expand All @@ -32,7 +32,7 @@ export function findPetsByTagsQueryOptions<
>(
headers: FindPetsByTags['headerParams'],
params?: FindPetsByTags['queryParams'],
options: FindPetsByTags['client']['paramaters'] = {},
options: FindPetsByTags['client']['parameters'] = {},
): WithRequired<UseBaseQueryOptions<FindPetsByTags['response'], TError, TData, TQueryData>, 'queryKey'> {
const queryKey = findPetsByTagsQueryKey(params)
return {
Expand Down Expand Up @@ -61,7 +61,7 @@ export function useFindPetsByTags<
TQueryKey extends QueryKey = FindPetsByTagsQueryKey,
>(headers: FindPetsByTags['headerParams'], params?: FindPetsByTags['queryParams'], options: {
query?: UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
client?: FindPetsByTags['client']['paramaters']
client?: FindPetsByTags['client']['parameters']
} = {}): UseQueryResult<TData, TError> & {
queryKey: TQueryKey
} {
Expand All @@ -87,7 +87,7 @@ export function findPetsByTagsInfiniteQueryOptions<
>(
headers: FindPetsByTags['headerParams'],
params?: FindPetsByTags['queryParams'],
options: FindPetsByTags['client']['paramaters'] = {},
options: FindPetsByTags['client']['parameters'] = {},
): WithRequired<UseInfiniteQueryOptions<FindPetsByTags['response'], TError, TData, TQueryData>, 'queryKey'> {
const queryKey = findPetsByTagsInfiniteQueryKey(params)
return {
Expand Down Expand Up @@ -120,7 +120,7 @@ export function useFindPetsByTagsInfinite<
TQueryKey extends QueryKey = FindPetsByTagsInfiniteQueryKey,
>(headers: FindPetsByTags['headerParams'], params?: FindPetsByTags['queryParams'], options: {
query?: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
client?: FindPetsByTags['client']['paramaters']
client?: FindPetsByTags['client']['parameters']
} = {}): UseInfiniteQueryResult<TData, TError> & {
queryKey: TQueryKey
} {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ type GetPetById = {
headerParams: never
response: Awaited<ReturnType<GetPetByIdClient>>
client: {
paramaters: Partial<Parameters<GetPetByIdClient>[0]>
parameters: Partial<Parameters<GetPetByIdClient>[0]>
return: Awaited<ReturnType<GetPetByIdClient>>
}
}
Expand All @@ -26,7 +26,7 @@ export function getPetByIdQueryOptions<
TQueryData = GetPetById['response'],
>(
petId: GetPetByIdPathParams['petId'],
options: GetPetById['client']['paramaters'] = {},
options: GetPetById['client']['parameters'] = {},
): WithRequired<UseBaseQueryOptions<GetPetById['response'], TError, TData, TQueryData>, 'queryKey'> {
const queryKey = getPetByIdQueryKey(petId)
return {
Expand All @@ -53,7 +53,7 @@ export function useGetPetById<
TQueryKey extends QueryKey = GetPetByIdQueryKey,
>(petId: GetPetByIdPathParams['petId'], options: {
query?: UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
client?: GetPetById['client']['paramaters']
client?: GetPetById['client']['parameters']
} = {}): UseQueryResult<TData, TError> & {
queryKey: TQueryKey
} {
Expand All @@ -78,7 +78,7 @@ export function getPetByIdInfiniteQueryOptions<
TQueryData = GetPetById['response'],
>(
petId: GetPetByIdPathParams['petId'],
options: GetPetById['client']['paramaters'] = {},
options: GetPetById['client']['parameters'] = {},
): WithRequired<UseInfiniteQueryOptions<GetPetById['response'], TError, TData, TQueryData>, 'queryKey'> {
const queryKey = getPetByIdInfiniteQueryKey(petId)
return {
Expand All @@ -105,7 +105,7 @@ export function useGetPetByIdInfinite<
TQueryKey extends QueryKey = GetPetByIdInfiniteQueryKey,
>(petId: GetPetByIdPathParams['petId'], options: {
query?: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
client?: GetPetById['client']['paramaters']
client?: GetPetById['client']['parameters']
} = {}): UseInfiniteQueryResult<TData, TError> & {
queryKey: TQueryKey
} {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ type UpdatePet = {
headerParams: never
response: Awaited<ReturnType<UpdatePetClient>>
client: {
paramaters: Partial<Parameters<UpdatePetClient>[0]>
parameters: Partial<Parameters<UpdatePetClient>[0]>
return: Awaited<ReturnType<UpdatePetClient>>
}
}
Expand All @@ -23,7 +23,7 @@ type UpdatePet = {
* @link /pet */
export function useUpdatePet(options: {
mutation?: UseMutationOptions<UpdatePet['response'], UpdatePet['error'], UpdatePet['request']>
client?: UpdatePet['client']['paramaters']
client?: UpdatePet['client']['parameters']
} = {}): UseMutationResult<UpdatePet['response'], UpdatePet['error'], UpdatePet['request']> {
const { mutation: mutationOptions, client: clientOptions = {} } = options ?? {}
return useMutation<UpdatePet['response'], UpdatePet['error'], UpdatePet['request']>({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ type UpdatePetWithForm = {
headerParams: never
response: Awaited<ReturnType<UpdatePetWithFormClient>>
client: {
paramaters: Partial<Parameters<UpdatePetWithFormClient>[0]>
parameters: Partial<Parameters<UpdatePetWithFormClient>[0]>
return: Awaited<ReturnType<UpdatePetWithFormClient>>
}
}
Expand All @@ -27,7 +27,7 @@ type UpdatePetWithForm = {
* @link /pet/:petId */
export function useUpdatePetWithForm(petId: UpdatePetWithFormPathParams['petId'], params?: UpdatePetWithForm['queryParams'], options: {
mutation?: UseMutationOptions<UpdatePetWithForm['response'], UpdatePetWithForm['error'], void>
client?: UpdatePetWithForm['client']['paramaters']
client?: UpdatePetWithForm['client']['parameters']
} = {}): UseMutationResult<UpdatePetWithForm['response'], UpdatePetWithForm['error'], void> {
const { mutation: mutationOptions, client: clientOptions = {} } = options ?? {}
return useMutation<UpdatePetWithForm['response'], UpdatePetWithForm['error'], void>({
Expand Down
Loading

1 comment on commit 72a1efb

@vercel
Copy link

@vercel vercel bot commented on 72a1efb Dec 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

kubb – ./

kubb-kubb.vercel.app
kubb-git-main-kubb.vercel.app
www.kubb.dev
kubb.dev

Please sign in to comment.