Skip to content

Commit

Permalink
Add operation suffix test
Browse files Browse the repository at this point in the history
  • Loading branch information
@markerikson
markerikson committed Aug 30, 2024
1 parent 5bd39b0 commit 6b1f11d
Show file tree
Hide file tree
Showing 2 changed files with 329 additions and 0 deletions.
317 changes: 317 additions & 0 deletions packages/rtk-query-codegen-openapi/test/__snapshots__/generateEndpoints.test.ts.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2524,6 +2524,323 @@ export type ExampleSchemaWrite = {
"
`;

exports[`operation suffixes are applied 1`] = `
"import { api } from "./fixtures/emptyApi";
const injectedRtkApi = api.injectEndpoints({
endpoints: (build) => ({
GetHealthcheckV2: build.query<
GetHealthcheckV2ApiResponse,
GetHealthcheckV2ApiArg
>({
query: () => ({ url: \`/healthcheck\` }),
}),
UpdatePetV2: build.mutation<UpdatePetV2ApiResponse, UpdatePetV2ApiArg>({
query: (queryArg) => ({ url: \`/pet\`, method: "PUT", body: queryArg.pet }),
}),
AddPetV2: build.mutation<AddPetV2ApiResponse, AddPetV2ApiArg>({
query: (queryArg) => ({
url: \`/pet\`,
method: "POST",
body: queryArg.pet,
}),
}),
FindPetsByStatusV2: build.query<
FindPetsByStatusV2ApiResponse,
FindPetsByStatusV2ApiArg
>({
query: (queryArg) => ({
url: \`/pet/findByStatus\`,
params: {
status: queryArg.status,
},
}),
}),
FindPetsByTagsV2: build.query<
FindPetsByTagsV2ApiResponse,
FindPetsByTagsV2ApiArg
>({
query: (queryArg) => ({
url: \`/pet/findByTags\`,
params: {
tags: queryArg.tags,
},
}),
}),
GetPetByIdV2: build.query<GetPetByIdV2ApiResponse, GetPetByIdV2ApiArg>({
query: (queryArg) => ({ url: \`/pet/\${queryArg.petId}\` }),
}),
UpdatePetWithFormV2: build.mutation<
UpdatePetWithFormV2ApiResponse,
UpdatePetWithFormV2ApiArg
>({
query: (queryArg) => ({
url: \`/pet/\${queryArg.petId}\`,
method: "POST",
params: {
name: queryArg.name,
status: queryArg.status,
},
}),
}),
DeletePetV2: build.mutation<DeletePetV2ApiResponse, DeletePetV2ApiArg>({
query: (queryArg) => ({
url: \`/pet/\${queryArg.petId}\`,
method: "DELETE",
headers: {
api_key: queryArg.apiKey,
},
}),
}),
UploadFileV2: build.mutation<UploadFileV2ApiResponse, UploadFileV2ApiArg>({
query: (queryArg) => ({
url: \`/pet/\${queryArg.petId}/uploadImage\`,
method: "POST",
body: queryArg.body,
params: {
additionalMetadata: queryArg.additionalMetadata,
},
}),
}),
GetInventoryV2: build.query<
GetInventoryV2ApiResponse,
GetInventoryV2ApiArg
>({
query: () => ({ url: \`/store/inventory\` }),
}),
PlaceOrderV2: build.mutation<PlaceOrderV2ApiResponse, PlaceOrderV2ApiArg>({
query: (queryArg) => ({
url: \`/store/order\`,
method: "POST",
body: queryArg.order,
}),
}),
GetOrderByIdV2: build.query<
GetOrderByIdV2ApiResponse,
GetOrderByIdV2ApiArg
>({
query: (queryArg) => ({ url: \`/store/order/\${queryArg.orderId}\` }),
}),
DeleteOrderV2: build.mutation<
DeleteOrderV2ApiResponse,
DeleteOrderV2ApiArg
>({
query: (queryArg) => ({
url: \`/store/order/\${queryArg.orderId}\`,
method: "DELETE",
}),
}),
CreateUserV2: build.mutation<CreateUserV2ApiResponse, CreateUserV2ApiArg>({
query: (queryArg) => ({
url: \`/user\`,
method: "POST",
body: queryArg.user,
}),
}),
CreateUsersWithListInputV2: build.mutation<
CreateUsersWithListInputV2ApiResponse,
CreateUsersWithListInputV2ApiArg
>({
query: (queryArg) => ({
url: \`/user/createWithList\`,
method: "POST",
body: queryArg.body,
}),
}),
LoginUserV2: build.query<LoginUserV2ApiResponse, LoginUserV2ApiArg>({
query: (queryArg) => ({
url: \`/user/login\`,
params: {
username: queryArg.username,
password: queryArg.password,
},
}),
}),
LogoutUserV2: build.query<LogoutUserV2ApiResponse, LogoutUserV2ApiArg>({
query: () => ({ url: \`/user/logout\` }),
}),
GetUserByNameV2: build.query<
GetUserByNameV2ApiResponse,
GetUserByNameV2ApiArg
>({
query: (queryArg) => ({ url: \`/user/\${queryArg.username}\` }),
}),
UpdateUserV2: build.mutation<UpdateUserV2ApiResponse, UpdateUserV2ApiArg>({
query: (queryArg) => ({
url: \`/user/\${queryArg.username}\`,
method: "PUT",
body: queryArg.user,
}),
}),
DeleteUserV2: build.mutation<DeleteUserV2ApiResponse, DeleteUserV2ApiArg>({
query: (queryArg) => ({
url: \`/user/\${queryArg.username}\`,
method: "DELETE",
}),
}),
}),
overrideExisting: false,
});
export { injectedRtkApi as enhancedApi };
export type GetHealthcheckV2ApiResponse = /** status 200 OK */ {
message: string;
};
export type GetHealthcheckV2ApiArg = void;
export type UpdatePetV2ApiResponse = /** status 200 Successful operation */ Pet;
export type UpdatePetV2ApiArg = {
/** Update an existent pet in the store */
pet: Pet;
};
export type AddPetV2ApiResponse = /** status 200 Successful operation */ Pet;
export type AddPetV2ApiArg = {
/** Create a new pet in the store */
pet: Pet;
};
export type FindPetsByStatusV2ApiResponse =
/** status 200 successful operation */ Pet[];
export type FindPetsByStatusV2ApiArg = {
/** Status values that need to be considered for filter */
status?: "available" | "pending" | "sold";
};
export type FindPetsByTagsV2ApiResponse =
/** status 200 successful operation */ Pet[];
export type FindPetsByTagsV2ApiArg = {
/** Tags to filter by */
tags?: string[];
};
export type GetPetByIdV2ApiResponse =
/** status 200 successful operation */ Pet;
export type GetPetByIdV2ApiArg = {
/** ID of pet to return */
petId: number;
};
export type UpdatePetWithFormV2ApiResponse = unknown;
export type UpdatePetWithFormV2ApiArg = {
/** ID of pet that needs to be updated */
petId: number;
/** Name of pet that needs to be updated */
name?: string;
/** Status of pet that needs to be updated */
status?: string;
};
export type DeletePetV2ApiResponse = unknown;
export type DeletePetV2ApiArg = {
apiKey?: string;
/** Pet id to delete */
petId: number;
};
export type UploadFileV2ApiResponse =
/** status 200 successful operation */ ApiResponse;
export type UploadFileV2ApiArg = {
/** ID of pet to update */
petId: number;
/** Additional Metadata */
additionalMetadata?: string;
body: Blob;
};
export type GetInventoryV2ApiResponse = /** status 200 successful operation */ {
[key: string]: number;
};
export type GetInventoryV2ApiArg = void;
export type PlaceOrderV2ApiResponse =
/** status 200 successful operation */ Order;
export type PlaceOrderV2ApiArg = {
order: Order;
};
export type GetOrderByIdV2ApiResponse =
/** status 200 successful operation */ Order;
export type GetOrderByIdV2ApiArg = {
/** ID of order that needs to be fetched */
orderId: number;
};
export type DeleteOrderV2ApiResponse = unknown;
export type DeleteOrderV2ApiArg = {
/** ID of the order that needs to be deleted */
orderId: number;
};
export type CreateUserV2ApiResponse =
/** status default successful operation */ User;
export type CreateUserV2ApiArg = {
/** Created user object */
user: User;
};
export type CreateUsersWithListInputV2ApiResponse =
/** status 200 Successful operation */ User;
export type CreateUsersWithListInputV2ApiArg = {
body: User[];
};
export type LoginUserV2ApiResponse =
/** status 200 successful operation */ string;
export type LoginUserV2ApiArg = {
/** The user name for login */
username?: string;
/** The password for login in clear text */
password?: string;
};
export type LogoutUserV2ApiResponse = unknown;
export type LogoutUserV2ApiArg = void;
export type GetUserByNameV2ApiResponse =
/** status 200 successful operation */ User;
export type GetUserByNameV2ApiArg = {
/** The name that needs to be fetched. Use user1 for testing. */
username: string;
};
export type UpdateUserV2ApiResponse = unknown;
export type UpdateUserV2ApiArg = {
/** name that need to be deleted */
username: string;
/** Update an existent user in the store */
user: User;
};
export type DeleteUserV2ApiResponse = unknown;
export type DeleteUserV2ApiArg = {
/** The name that needs to be deleted */
username: string;
};
export type Category = {
id?: number | undefined;
name?: string | undefined;
};
export type Tag = {
id?: number | undefined;
name?: string | undefined;
};
export type Pet = {
id?: number | undefined;
name: string;
category?: Category | undefined;
photoUrls: string[];
tags?: Tag[] | undefined;
/** pet status in the store */
status?: ("available" | "pending" | "sold") | undefined;
};
export type ApiResponse = {
code?: number | undefined;
type?: string | undefined;
message?: string | undefined;
};
export type Order = {
id?: number | undefined;
petId?: number | undefined;
quantity?: number | undefined;
shipDate?: string | undefined;
/** Order Status */
status?: ("placed" | "approved" | "delivered") | undefined;
complete?: boolean | undefined;
};
export type User = {
id?: number | undefined;
username?: string | undefined;
firstName?: string | undefined;
lastName?: string | undefined;
email?: string | undefined;
password?: string | undefined;
phone?: string | undefined;
/** User Status */
userStatus?: number | undefined;
};
"
`;

exports[`query parameters > parameters overridden in swagger should also be overridden in the code 1`] = `
"import { api } from "./fixtures/emptyApi";
const injectedRtkApi = api.injectEndpoints({
Expand Down
12 changes: 12 additions & 0 deletions packages/rtk-query-codegen-openapi/test/generateEndpoints.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,18 @@ test('duplicate parameter names must be prefixed with a path or query prefix', a
expect(api).toMatchSnapshot();
});

test('operation suffixes are applied', async () => {
const api = await generateEndpoints({
unionUndefined: true,
apiFile: './fixtures/emptyApi.ts',
schemaFile: resolve(__dirname, 'fixtures/petstore.json'),
operationNameSuffix: 'V2',
});

expect(api).toContain('AddPetV2');
expect(api).toMatchSnapshot();
});

test('apiImport builds correct `import` statement', async () => {
const api = await generateEndpoints({
unionUndefined: true,
Expand Down

0 comments on commit 6b1f11d

Please sign in to comment.