Skip to content

Commit e4468e7

Browse files
committed
Improve
1 parent d22d725 commit e4468e7

92 files changed

Lines changed: 2152 additions & 2153 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@povio/openapi-codegen-cli",
3-
"version": "2.0.8-rc.12",
3+
"version": "2.0.8-rc.13",
44
"keywords": [
55
"codegen",
66
"openapi",

src/generators/generate/generateQueries.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -461,9 +461,8 @@ function renderQueryJsDocs({
461461
...(mode !== "infiniteQuery" ? { includeFileParam: true } : {}),
462462
});
463463
for (const endpointParam of params) {
464-
const source = mode === "mutation" ? "mutation" : "object";
465464
lines.push(
466-
` * @param { ${endpointParam.type} } ${source}.${endpointParam.name} ${renderEndpointParamDescription(endpointParam)}`,
465+
` * @param { ${endpointParam.type} } ${endpointParam.name} ${renderEndpointParamDescription(endpointParam)}`,
467466
);
468467
}
469468

test/generated/tmp-localhost-models-inline-fresh/aWBStocks/aWBStocks.queries.ts

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,12 @@ export const keys = {
9191
* Query `usePaginate`
9292
* @summary List AWB stocks
9393
* @permission Requires `canUsePaginate` ability
94-
* @param { string } object.officeId Path parameter
95-
* @param { number } object.limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
96-
* @param { string } object.order Query parameter. Order by fields (comma separated with +/- prefix): createdAt, updatedAt, createdBy, updatedBy, carrierName, startNumber, priority. Example: `createdAt`
97-
* @param { AWBStocksModels.AWBStockFilterDto } object.filter Query parameter
98-
* @param { number } object.page Query parameter. 1-indexed page number to begin from
99-
* @param { string } object.cursor Query parameter. ID of item to start after
94+
* @param { string } officeId Path parameter
95+
* @param { number } limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
96+
* @param { string } order Query parameter. Order by fields (comma separated with +/- prefix): createdAt, updatedAt, createdBy, updatedBy, carrierName, startNumber, priority. Example: `createdAt`
97+
* @param { AWBStocksModels.AWBStockFilterDto } filter Query parameter
98+
* @param { number } page Query parameter. 1-indexed page number to begin from
99+
* @param { string } cursor Query parameter. ID of item to start after
100100
* @param { AppQueryOptions } options Query options
101101
* @returns { UseQueryResult<AWBStocksModels.AWBStocksPaginateResponse> }
102102
* @statusCodes [200, 401]
@@ -118,12 +118,12 @@ export const usePaginate = <TData>({ officeId, limit, order, filter, page, curso
118118
* Infinite query `usePaginateInfinite
119119
* @summary List AWB stocks
120120
* @permission Requires `canUsePaginate` ability
121-
* @param { string } object.officeId Path parameter
122-
* @param { number } object.limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
123-
* @param { string } object.order Query parameter. Order by fields (comma separated with +/- prefix): createdAt, updatedAt, createdBy, updatedBy, carrierName, startNumber, priority. Example: `createdAt`
124-
* @param { AWBStocksModels.AWBStockFilterDto } object.filter Query parameter
125-
* @param { number } object.page Query parameter. 1-indexed page number to begin from
126-
* @param { string } object.cursor Query parameter. ID of item to start after
121+
* @param { string } officeId Path parameter
122+
* @param { number } limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
123+
* @param { string } order Query parameter. Order by fields (comma separated with +/- prefix): createdAt, updatedAt, createdBy, updatedBy, carrierName, startNumber, priority. Example: `createdAt`
124+
* @param { AWBStocksModels.AWBStockFilterDto } filter Query parameter
125+
* @param { number } page Query parameter. 1-indexed page number to begin from
126+
* @param { string } cursor Query parameter. ID of item to start after
127127
* @param { AppInfiniteQueryOptions } options Infinite query options
128128
* @returns { UseInfiniteQueryResult<AWBStocksModels.AWBStocksPaginateResponse> }
129129
* @statusCodes [200, 401]
@@ -150,8 +150,8 @@ export const usePaginateInfinite = <TData>({ officeId, limit, order, filter, cur
150150
* Mutation `useCreate`
151151
* @summary Create AWB stock
152152
* @permission Requires `canUseCreate` ability
153-
* @param { string } mutation.officeId Path parameter
154-
* @param { AWBStocksModels.CreateAWBStockRequestDTO } mutation.data Body parameter
153+
* @param { string } officeId Path parameter
154+
* @param { AWBStocksModels.CreateAWBStockRequestDTO } data Body parameter
155155
* @param { AppMutationOptions & MutationEffectsOptions } options Mutation options
156156
* @returns { UseMutationResult<AWBStocksModels.AWBStockResponseDTO> }
157157
* @statusCodes [201, 401]
@@ -178,8 +178,8 @@ export const useCreate = (options?: AppMutationOptions<typeof create, { officeId
178178
* Query `useFindById`
179179
* @summary Get AWB stock details
180180
* @permission Requires `canUseFindById` ability
181-
* @param { string } object.stockId Path parameter
182-
* @param { string } object.officeId Path parameter
181+
* @param { string } stockId Path parameter
182+
* @param { string } officeId Path parameter
183183
* @param { AppQueryOptions } options Query options
184184
* @returns { UseQueryResult<AWBStocksModels.AWBStockResponseDTO> }
185185
* @statusCodes [200, 401]
@@ -201,9 +201,9 @@ export const useFindById = <TData>({ stockId, officeId }: { stockId: string, off
201201
* Mutation `useUpdate`
202202
* @summary Update AWB stock comments
203203
* @permission Requires `canUseUpdate` ability
204-
* @param { string } mutation.stockId Path parameter
205-
* @param { string } mutation.officeId Path parameter
206-
* @param { AWBStocksModels.UpdateAWBStockRequestDTO } mutation.data Body parameter
204+
* @param { string } stockId Path parameter
205+
* @param { string } officeId Path parameter
206+
* @param { AWBStocksModels.UpdateAWBStockRequestDTO } data Body parameter
207207
* @param { AppMutationOptions & MutationEffectsOptions } options Mutation options
208208
* @returns { UseMutationResult<AWBStocksModels.AWBStockResponseDTO> }
209209
* @statusCodes [200, 401]
@@ -232,8 +232,8 @@ export const useUpdate = (options?: AppMutationOptions<typeof update, { stockId:
232232
* Mutation `useArchive`
233233
* @summary Archive AWB stock
234234
* @permission Requires `canUseArchive` ability
235-
* @param { string } mutation.stockId Path parameter
236-
* @param { string } mutation.officeId Path parameter
235+
* @param { string } stockId Path parameter
236+
* @param { string } officeId Path parameter
237237
* @param { AppMutationOptions & MutationEffectsOptions } options Mutation options
238238
* @returns { UseMutationResult<AWBStocksModels.AWBStockResponseDTO> }
239239
* @statusCodes [200, 401]
@@ -262,8 +262,8 @@ export const useArchive = (options?: AppMutationOptions<typeof archive, { stockI
262262
* Mutation `useUnarchive`
263263
* @summary Unarchive AWB stock
264264
* @permission Requires `canUseUnarchive` ability
265-
* @param { string } mutation.stockId Path parameter
266-
* @param { string } mutation.officeId Path parameter
265+
* @param { string } stockId Path parameter
266+
* @param { string } officeId Path parameter
267267
* @param { AppMutationOptions & MutationEffectsOptions } options Mutation options
268268
* @returns { UseMutationResult<AWBStocksModels.AWBStockResponseDTO> }
269269
* @statusCodes [200, 401]
@@ -292,8 +292,8 @@ export const useUnarchive = (options?: AppMutationOptions<typeof unarchive, { st
292292
* Mutation `useGenerateNextNumber`
293293
* @summary Generate next AWB number for carrier
294294
* @permission Requires `canUseGenerateNextNumber` ability
295-
* @param { string } mutation.officeId Path parameter
296-
* @param { AWBStocksModels.GenerateAWBNumberRequestDTO } mutation.data Body parameter
295+
* @param { string } officeId Path parameter
296+
* @param { AWBStocksModels.GenerateAWBNumberRequestDTO } data Body parameter
297297
* @param { AppMutationOptions & MutationEffectsOptions } options Mutation options
298298
* @returns { UseMutationResult<AWBStocksModels.GenerateAWBNumberResponseDTO> }
299299
* @statusCodes [201, 401]

test/generated/tmp-localhost-models-inline-fresh/airports/airports.queries.ts

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,11 @@ export const keys = {
8484
* Query `usePaginate`
8585
* @summary Paginate Airports
8686
* @permission Requires `canUsePaginate` ability
87-
* @param { number } object.limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
88-
* @param { string } object.order Query parameter. Order by fields (comma separated with +/- prefix): name, matchCode, iataCode, createdAt, updatedAt, createdBy, updatedBy. Example: `name`
89-
* @param { AirportsModels.AirportPaginationFilterDto } object.filter Query parameter
90-
* @param { number } object.page Query parameter. 1-indexed page number to begin from
91-
* @param { string } object.cursor Query parameter. ID of item to start after
87+
* @param { number } limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
88+
* @param { string } order Query parameter. Order by fields (comma separated with +/- prefix): name, matchCode, iataCode, createdAt, updatedAt, createdBy, updatedBy. Example: `name`
89+
* @param { AirportsModels.AirportPaginationFilterDto } filter Query parameter
90+
* @param { number } page Query parameter. 1-indexed page number to begin from
91+
* @param { string } cursor Query parameter. ID of item to start after
9292
* @param { AppQueryOptions } options Query options
9393
* @returns { UseQueryResult<AirportsModels.AirportsPaginateResponse> }
9494
* @statusCodes [200, 401]
@@ -110,11 +110,11 @@ export const usePaginate = <TData>({ limit, order, filter, page, cursor }: { lim
110110
* Infinite query `usePaginateInfinite
111111
* @summary Paginate Airports
112112
* @permission Requires `canUsePaginate` ability
113-
* @param { number } object.limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
114-
* @param { string } object.order Query parameter. Order by fields (comma separated with +/- prefix): name, matchCode, iataCode, createdAt, updatedAt, createdBy, updatedBy. Example: `name`
115-
* @param { AirportsModels.AirportPaginationFilterDto } object.filter Query parameter
116-
* @param { number } object.page Query parameter. 1-indexed page number to begin from
117-
* @param { string } object.cursor Query parameter. ID of item to start after
113+
* @param { number } limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
114+
* @param { string } order Query parameter. Order by fields (comma separated with +/- prefix): name, matchCode, iataCode, createdAt, updatedAt, createdBy, updatedBy. Example: `name`
115+
* @param { AirportsModels.AirportPaginationFilterDto } filter Query parameter
116+
* @param { number } page Query parameter. 1-indexed page number to begin from
117+
* @param { string } cursor Query parameter. ID of item to start after
118118
* @param { AppInfiniteQueryOptions } options Infinite query options
119119
* @returns { UseInfiniteQueryResult<AirportsModels.AirportsPaginateResponse> }
120120
* @statusCodes [200, 401]
@@ -141,7 +141,7 @@ export const usePaginateInfinite = <TData>({ limit, order, filter, cursor }: { l
141141
* Mutation `useCreate`
142142
* @summary Create airport
143143
* @permission Requires `canUseCreate` ability
144-
* @param { AirportsModels.CreateAirportRequestDTO } mutation.data Body parameter
144+
* @param { AirportsModels.CreateAirportRequestDTO } data Body parameter
145145
* @param { AppMutationOptions & MutationEffectsOptions } options Mutation options
146146
* @returns { UseMutationResult<AirportsModels.AirportResponseDTO> }
147147
* @statusCodes [200, 201, 401]
@@ -168,11 +168,11 @@ export const useCreate = (options?: AppMutationOptions<typeof create, { data: Ai
168168
* Query `usePaginateLabels`
169169
* @summary Paginate airports with only their labels
170170
* @permission Requires `canUsePaginateLabels` ability
171-
* @param { number } object.limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
172-
* @param { string } object.order Query parameter. Order by fields (comma separated with +/- prefix): name, matchCode, iataCode, createdAt, updatedAt, createdBy, updatedBy. Example: `name`
173-
* @param { AirportsModels.AirportLabelFilterDto } object.filter Query parameter
174-
* @param { number } object.page Query parameter. 1-indexed page number to begin from
175-
* @param { string } object.cursor Query parameter. ID of item to start after
171+
* @param { number } limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
172+
* @param { string } order Query parameter. Order by fields (comma separated with +/- prefix): name, matchCode, iataCode, createdAt, updatedAt, createdBy, updatedBy. Example: `name`
173+
* @param { AirportsModels.AirportLabelFilterDto } filter Query parameter
174+
* @param { number } page Query parameter. 1-indexed page number to begin from
175+
* @param { string } cursor Query parameter. ID of item to start after
176176
* @param { AppQueryOptions } options Query options
177177
* @returns { UseQueryResult<AirportsModels.AirportsPaginateLabelsResponse> }
178178
* @statusCodes [200, 401]
@@ -194,11 +194,11 @@ export const usePaginateLabels = <TData>({ limit, order, filter, page, cursor }:
194194
* Infinite query `usePaginateLabelsInfinite
195195
* @summary Paginate airports with only their labels
196196
* @permission Requires `canUsePaginateLabels` ability
197-
* @param { number } object.limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
198-
* @param { string } object.order Query parameter. Order by fields (comma separated with +/- prefix): name, matchCode, iataCode, createdAt, updatedAt, createdBy, updatedBy. Example: `name`
199-
* @param { AirportsModels.AirportLabelFilterDto } object.filter Query parameter
200-
* @param { number } object.page Query parameter. 1-indexed page number to begin from
201-
* @param { string } object.cursor Query parameter. ID of item to start after
197+
* @param { number } limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
198+
* @param { string } order Query parameter. Order by fields (comma separated with +/- prefix): name, matchCode, iataCode, createdAt, updatedAt, createdBy, updatedBy. Example: `name`
199+
* @param { AirportsModels.AirportLabelFilterDto } filter Query parameter
200+
* @param { number } page Query parameter. 1-indexed page number to begin from
201+
* @param { string } cursor Query parameter. ID of item to start after
202202
* @param { AppInfiniteQueryOptions } options Infinite query options
203203
* @returns { UseInfiniteQueryResult<AirportsModels.AirportsPaginateLabelsResponse> }
204204
* @statusCodes [200, 401]
@@ -225,8 +225,8 @@ export const usePaginateLabelsInfinite = <TData>({ limit, order, filter, cursor
225225
* Mutation `useUpdate`
226226
* @summary Update airport
227227
* @permission Requires `canUseUpdate` ability
228-
* @param { string } mutation.id Path parameter
229-
* @param { AirportsModels.UpdateAirportRequestDTO } mutation.data Body parameter
228+
* @param { string } id Path parameter
229+
* @param { AirportsModels.UpdateAirportRequestDTO } data Body parameter
230230
* @param { AppMutationOptions & MutationEffectsOptions } options Mutation options
231231
* @returns { UseMutationResult<AirportsModels.AirportResponseDTO> }
232232
* @statusCodes [200, 401]
@@ -255,7 +255,7 @@ export const useUpdate = (options?: AppMutationOptions<typeof update, { id: stri
255255
* Query `useFindById`
256256
* @summary Get airport
257257
* @permission Requires `canUseFindById` ability
258-
* @param { string } object.id Path parameter
258+
* @param { string } id Path parameter
259259
* @param { AppQueryOptions } options Query options
260260
* @returns { UseQueryResult<AirportsModels.AirportResponseDTO> }
261261
* @statusCodes [200, 401]

test/generated/tmp-localhost-models-inline-fresh/bankAccounts/bankAccounts.queries.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ export const keys = {
5252
* Query `useFindAll`
5353
* @summary List all bank accounts with only their labels
5454
* @permission Requires `canUseFindAll` ability
55-
* @param { string } object.search Query parameter
56-
* @param { string } object.officeId Query parameter
55+
* @param { string } search Query parameter
56+
* @param { string } officeId Query parameter
5757
* @param { AppQueryOptions } options Query options
5858
* @returns { UseQueryResult<BankAccountsModels.BankAccountsFindAllResponse> }
5959
* @statusCodes [200, 401]
@@ -75,11 +75,11 @@ export const useFindAll = <TData>({ search, officeId }: { search?: string, offic
7575
* Query `usePaginateLabels`
7676
* @summary Paginate bank account labels (id and name only)
7777
* @permission Requires `canUsePaginateLabels` ability
78-
* @param { number } object.limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
79-
* @param { string } object.order Query parameter. Order by fields (comma separated with +/- prefix): name, bankName, createdAt, updatedAt. Example: `name`
80-
* @param { BankAccountsModels.BankAccountFilterDto } object.filter Query parameter
81-
* @param { number } object.page Query parameter. 1-indexed page number to begin from
82-
* @param { string } object.cursor Query parameter. ID of item to start after
78+
* @param { number } limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
79+
* @param { string } order Query parameter. Order by fields (comma separated with +/- prefix): name, bankName, createdAt, updatedAt. Example: `name`
80+
* @param { BankAccountsModels.BankAccountFilterDto } filter Query parameter
81+
* @param { number } page Query parameter. 1-indexed page number to begin from
82+
* @param { string } cursor Query parameter. ID of item to start after
8383
* @param { AppQueryOptions } options Query options
8484
* @returns { UseQueryResult<BankAccountsModels.BankAccountsPaginateLabelsResponse> }
8585
* @statusCodes [200, 401]
@@ -101,11 +101,11 @@ export const usePaginateLabels = <TData>({ limit, order, filter, page, cursor }:
101101
* Infinite query `usePaginateLabelsInfinite
102102
* @summary Paginate bank account labels (id and name only)
103103
* @permission Requires `canUsePaginateLabels` ability
104-
* @param { number } object.limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
105-
* @param { string } object.order Query parameter. Order by fields (comma separated with +/- prefix): name, bankName, createdAt, updatedAt. Example: `name`
106-
* @param { BankAccountsModels.BankAccountFilterDto } object.filter Query parameter
107-
* @param { number } object.page Query parameter. 1-indexed page number to begin from
108-
* @param { string } object.cursor Query parameter. ID of item to start after
104+
* @param { number } limit Query parameter. Items per response. Minimum: `1`. Maximum: `100`. Default: `20`
105+
* @param { string } order Query parameter. Order by fields (comma separated with +/- prefix): name, bankName, createdAt, updatedAt. Example: `name`
106+
* @param { BankAccountsModels.BankAccountFilterDto } filter Query parameter
107+
* @param { number } page Query parameter. 1-indexed page number to begin from
108+
* @param { string } cursor Query parameter. ID of item to start after
109109
* @param { AppInfiniteQueryOptions } options Infinite query options
110110
* @returns { UseInfiniteQueryResult<BankAccountsModels.BankAccountsPaginateLabelsResponse> }
111111
* @statusCodes [200, 401]

0 commit comments

Comments
 (0)