Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): fix typo parameters #728

Merged
merged 1 commit into from
Dec 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 @@
headerParams: never
response: Awaited<ReturnType<AddPetClient>>
client: {
paramaters: Partial<Parameters<AddPetClient>[0]>
parameters: Partial<Parameters<AddPetClient>[0]>

Check warning on line 16 in examples/advanced/src/gen/clients/hooks/petController/useAddPet.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useAddPet.ts#L16

Added line #L16 was not covered by tests
return: Awaited<ReturnType<AddPetClient>>
}
}
Expand All @@ -23,7 +23,7 @@
* @link /pet */
export function useAddPet(options: {
mutation?: UseMutationOptions<AddPet['response'], AddPet['error'], AddPet['request']>
client?: AddPet['client']['paramaters']
client?: AddPet['client']['parameters']

Check warning on line 26 in examples/advanced/src/gen/clients/hooks/petController/useAddPet.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useAddPet.ts#L26

Added line #L26 was not covered by tests
} = {}): 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 @@
headerParams: DeletePetHeaderParams
response: Awaited<ReturnType<DeletePetClient>>
client: {
paramaters: Partial<Parameters<DeletePetClient>[0]>
parameters: Partial<Parameters<DeletePetClient>[0]>

Check warning on line 16 in examples/advanced/src/gen/clients/hooks/petController/useDeletePet.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useDeletePet.ts#L16

Added line #L16 was not covered by tests
return: Awaited<ReturnType<DeletePetClient>>
}
}
Expand All @@ -23,7 +23,7 @@
* @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']

Check warning on line 26 in examples/advanced/src/gen/clients/hooks/petController/useDeletePet.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useDeletePet.ts#L26

Added line #L26 was not covered by tests
} = {}): 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 @@
headerParams: never
response: Awaited<ReturnType<FindPetsByStatusClient>>
client: {
paramaters: Partial<Parameters<FindPetsByStatusClient>[0]>
parameters: Partial<Parameters<FindPetsByStatusClient>[0]>

Check warning on line 16 in examples/advanced/src/gen/clients/hooks/petController/useFindPetsByStatus.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useFindPetsByStatus.ts#L16

Added line #L16 was not covered by tests
return: Awaited<ReturnType<FindPetsByStatusClient>>
}
}
Expand All @@ -26,7 +26,7 @@
TQueryData = FindPetsByStatus['response'],
>(
params?: FindPetsByStatus['queryParams'],
options: FindPetsByStatus['client']['paramaters'] = {},
options: FindPetsByStatus['client']['parameters'] = {},

Check warning on line 29 in examples/advanced/src/gen/clients/hooks/petController/useFindPetsByStatus.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useFindPetsByStatus.ts#L29

Added line #L29 was not covered by tests
): WithRequired<UseBaseQueryOptions<FindPetsByStatus['response'], TError, TData, TQueryData>, 'queryKey'> {
const queryKey = findPetsByStatusQueryKey(params)
return {
Expand Down Expand Up @@ -54,7 +54,7 @@
TQueryKey extends QueryKey = FindPetsByStatusQueryKey,
>(params?: FindPetsByStatus['queryParams'], options: {
query?: UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
client?: FindPetsByStatus['client']['paramaters']
client?: FindPetsByStatus['client']['parameters']

Check warning on line 57 in examples/advanced/src/gen/clients/hooks/petController/useFindPetsByStatus.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useFindPetsByStatus.ts#L57

Added line #L57 was not covered by tests
} = {}): UseQueryResult<TData, TError> & {
queryKey: TQueryKey
} {
Expand All @@ -80,7 +80,7 @@
TQueryData = FindPetsByStatus['response'],
>(
params?: FindPetsByStatus['queryParams'],
options: FindPetsByStatus['client']['paramaters'] = {},
options: FindPetsByStatus['client']['parameters'] = {},

Check warning on line 83 in examples/advanced/src/gen/clients/hooks/petController/useFindPetsByStatus.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useFindPetsByStatus.ts#L83

Added line #L83 was not covered by tests
): WithRequired<UseInfiniteQueryOptions<FindPetsByStatus['response'], TError, TData, TQueryData>, 'queryKey'> {
const queryKey = findPetsByStatusInfiniteQueryKey(params)
return {
Expand Down Expand Up @@ -112,7 +112,7 @@
TQueryKey extends QueryKey = FindPetsByStatusInfiniteQueryKey,
>(params?: FindPetsByStatus['queryParams'], options: {
query?: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
client?: FindPetsByStatus['client']['paramaters']
client?: FindPetsByStatus['client']['parameters']

Check warning on line 115 in examples/advanced/src/gen/clients/hooks/petController/useFindPetsByStatus.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useFindPetsByStatus.ts#L115

Added line #L115 was not covered by tests
} = {}): UseInfiniteQueryResult<TData, TError> & {
queryKey: TQueryKey
} {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
headerParams: FindPetsByTagsHeaderParams
response: Awaited<ReturnType<FindPetsByTagsClient>>
client: {
paramaters: Partial<Parameters<FindPetsByTagsClient>[0]>
parameters: Partial<Parameters<FindPetsByTagsClient>[0]>

Check warning on line 21 in examples/advanced/src/gen/clients/hooks/petController/useFindPetsByTags.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useFindPetsByTags.ts#L21

Added line #L21 was not covered by tests
return: Awaited<ReturnType<FindPetsByTagsClient>>
}
}
Expand All @@ -32,7 +32,7 @@
>(
headers: FindPetsByTags['headerParams'],
params?: FindPetsByTags['queryParams'],
options: FindPetsByTags['client']['paramaters'] = {},
options: FindPetsByTags['client']['parameters'] = {},

Check warning on line 35 in examples/advanced/src/gen/clients/hooks/petController/useFindPetsByTags.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useFindPetsByTags.ts#L35

Added line #L35 was not covered by tests
): WithRequired<UseBaseQueryOptions<FindPetsByTags['response'], TError, TData, TQueryData>, 'queryKey'> {
const queryKey = findPetsByTagsQueryKey(params)
return {
Expand Down Expand Up @@ -61,7 +61,7 @@
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']

Check warning on line 64 in examples/advanced/src/gen/clients/hooks/petController/useFindPetsByTags.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useFindPetsByTags.ts#L64

Added line #L64 was not covered by tests
} = {}): UseQueryResult<TData, TError> & {
queryKey: TQueryKey
} {
Expand All @@ -87,7 +87,7 @@
>(
headers: FindPetsByTags['headerParams'],
params?: FindPetsByTags['queryParams'],
options: FindPetsByTags['client']['paramaters'] = {},
options: FindPetsByTags['client']['parameters'] = {},

Check warning on line 90 in examples/advanced/src/gen/clients/hooks/petController/useFindPetsByTags.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useFindPetsByTags.ts#L90

Added line #L90 was not covered by tests
): WithRequired<UseInfiniteQueryOptions<FindPetsByTags['response'], TError, TData, TQueryData>, 'queryKey'> {
const queryKey = findPetsByTagsInfiniteQueryKey(params)
return {
Expand Down Expand Up @@ -120,7 +120,7 @@
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']

Check warning on line 123 in examples/advanced/src/gen/clients/hooks/petController/useFindPetsByTags.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useFindPetsByTags.ts#L123

Added line #L123 was not covered by tests
} = {}): UseInfiniteQueryResult<TData, TError> & {
queryKey: TQueryKey
} {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
headerParams: never
response: Awaited<ReturnType<GetPetByIdClient>>
client: {
paramaters: Partial<Parameters<GetPetByIdClient>[0]>
parameters: Partial<Parameters<GetPetByIdClient>[0]>

Check warning on line 16 in examples/advanced/src/gen/clients/hooks/petController/useGetPetById.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useGetPetById.ts#L16

Added line #L16 was not covered by tests
return: Awaited<ReturnType<GetPetByIdClient>>
}
}
Expand All @@ -26,7 +26,7 @@
TQueryData = GetPetById['response'],
>(
petId: GetPetByIdPathParams['petId'],
options: GetPetById['client']['paramaters'] = {},
options: GetPetById['client']['parameters'] = {},

Check warning on line 29 in examples/advanced/src/gen/clients/hooks/petController/useGetPetById.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useGetPetById.ts#L29

Added line #L29 was not covered by tests
): WithRequired<UseBaseQueryOptions<GetPetById['response'], TError, TData, TQueryData>, 'queryKey'> {
const queryKey = getPetByIdQueryKey(petId)
return {
Expand All @@ -53,7 +53,7 @@
TQueryKey extends QueryKey = GetPetByIdQueryKey,
>(petId: GetPetByIdPathParams['petId'], options: {
query?: UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
client?: GetPetById['client']['paramaters']
client?: GetPetById['client']['parameters']

Check warning on line 56 in examples/advanced/src/gen/clients/hooks/petController/useGetPetById.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useGetPetById.ts#L56

Added line #L56 was not covered by tests
} = {}): UseQueryResult<TData, TError> & {
queryKey: TQueryKey
} {
Expand All @@ -78,7 +78,7 @@
TQueryData = GetPetById['response'],
>(
petId: GetPetByIdPathParams['petId'],
options: GetPetById['client']['paramaters'] = {},
options: GetPetById['client']['parameters'] = {},

Check warning on line 81 in examples/advanced/src/gen/clients/hooks/petController/useGetPetById.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useGetPetById.ts#L81

Added line #L81 was not covered by tests
): WithRequired<UseInfiniteQueryOptions<GetPetById['response'], TError, TData, TQueryData>, 'queryKey'> {
const queryKey = getPetByIdInfiniteQueryKey(petId)
return {
Expand All @@ -105,7 +105,7 @@
TQueryKey extends QueryKey = GetPetByIdInfiniteQueryKey,
>(petId: GetPetByIdPathParams['petId'], options: {
query?: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
client?: GetPetById['client']['paramaters']
client?: GetPetById['client']['parameters']

Check warning on line 108 in examples/advanced/src/gen/clients/hooks/petController/useGetPetById.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useGetPetById.ts#L108

Added line #L108 was not covered by tests
} = {}): UseInfiniteQueryResult<TData, TError> & {
queryKey: TQueryKey
} {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
headerParams: never
response: Awaited<ReturnType<UpdatePetClient>>
client: {
paramaters: Partial<Parameters<UpdatePetClient>[0]>
parameters: Partial<Parameters<UpdatePetClient>[0]>

Check warning on line 16 in examples/advanced/src/gen/clients/hooks/petController/useUpdatePet.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useUpdatePet.ts#L16

Added line #L16 was not covered by tests
return: Awaited<ReturnType<UpdatePetClient>>
}
}
Expand All @@ -23,7 +23,7 @@
* @link /pet */
export function useUpdatePet(options: {
mutation?: UseMutationOptions<UpdatePet['response'], UpdatePet['error'], UpdatePet['request']>
client?: UpdatePet['client']['paramaters']
client?: UpdatePet['client']['parameters']

Check warning on line 26 in examples/advanced/src/gen/clients/hooks/petController/useUpdatePet.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useUpdatePet.ts#L26

Added line #L26 was not covered by tests
} = {}): 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 @@
headerParams: never
response: Awaited<ReturnType<UpdatePetWithFormClient>>
client: {
paramaters: Partial<Parameters<UpdatePetWithFormClient>[0]>
parameters: Partial<Parameters<UpdatePetWithFormClient>[0]>

Check warning on line 21 in examples/advanced/src/gen/clients/hooks/petController/useUpdatePetWithForm.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useUpdatePetWithForm.ts#L21

Added line #L21 was not covered by tests
return: Awaited<ReturnType<UpdatePetWithFormClient>>
}
}
Expand All @@ -27,7 +27,7 @@
* @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']

Check warning on line 30 in examples/advanced/src/gen/clients/hooks/petController/useUpdatePetWithForm.ts

View check run for this annotation

Codecov / codecov/patch

examples/advanced/src/gen/clients/hooks/petController/useUpdatePetWithForm.ts#L30

Added line #L30 was not covered by tests
} = {}): UseMutationResult<UpdatePetWithForm['response'], UpdatePetWithForm['error'], void> {
const { mutation: mutationOptions, client: clientOptions = {} } = options ?? {}
return useMutation<UpdatePetWithForm['response'], UpdatePetWithForm['error'], void>({
Expand Down
Loading
Loading