N21-1397 Generate API

src/serverApi/v3/api.ts

@@ -8953,15 +8953,15 @@ export const GroupApiAxiosParamCreator = function (configuration?: Configuration
     return {
         /**
          * 
-         * @summary Get a list of classes and groups of type class for the current users school.
+         * @summary Get a list of classes and groups of type class for the current user.
          * @param {number} [skip] Number of elements (not pages) to be skipped
          * @param {number} [limit] Page limit, defaults to 10.
          * @param {'asc' | 'desc'} [sortOrder] 
          * @param {'name' | 'externalSourceName'} [sortBy] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        groupControllerFindClassesForSchool: async (skip?: number, limit?: number, sortOrder?: 'asc' | 'desc', sortBy?: 'name' | 'externalSourceName', options: any = {}): Promise<RequestArgs> => {
+        groupControllerFindClasses: async (skip?: number, limit?: number, sortOrder?: 'asc' | 'desc', sortBy?: 'name' | 'externalSourceName', options: any = {}): Promise<RequestArgs> => {
             const localVarPath = `/groups/class`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -9055,16 +9055,16 @@ export const GroupApiFp = function(configuration?: Configuration) {
     return {
         /**
          * 
-         * @summary Get a list of classes and groups of type class for the current users school.
+         * @summary Get a list of classes and groups of type class for the current user.
          * @param {number} [skip] Number of elements (not pages) to be skipped
          * @param {number} [limit] Page limit, defaults to 10.
          * @param {'asc' | 'desc'} [sortOrder] 
          * @param {'name' | 'externalSourceName'} [sortBy] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async groupControllerFindClassesForSchool(skip?: number, limit?: number, sortOrder?: 'asc' | 'desc', sortBy?: 'name' | 'externalSourceName', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClassInfoSearchListResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.groupControllerFindClassesForSchool(skip, limit, sortOrder, sortBy, options);
+        async groupControllerFindClasses(skip?: number, limit?: number, sortOrder?: 'asc' | 'desc', sortBy?: 'name' | 'externalSourceName', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClassInfoSearchListResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.groupControllerFindClasses(skip, limit, sortOrder, sortBy, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -9090,16 +9090,16 @@ export const GroupApiFactory = function (configuration?: Configuration, basePath
     return {
         /**
          * 
-         * @summary Get a list of classes and groups of type class for the current users school.
+         * @summary Get a list of classes and groups of type class for the current user.
          * @param {number} [skip] Number of elements (not pages) to be skipped
          * @param {number} [limit] Page limit, defaults to 10.
          * @param {'asc' | 'desc'} [sortOrder] 
          * @param {'name' | 'externalSourceName'} [sortBy] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        groupControllerFindClassesForSchool(skip?: number, limit?: number, sortOrder?: 'asc' | 'desc', sortBy?: 'name' | 'externalSourceName', options?: any): AxiosPromise<ClassInfoSearchListResponse> {
-            return localVarFp.groupControllerFindClassesForSchool(skip, limit, sortOrder, sortBy, options).then((request) => request(axios, basePath));
+        groupControllerFindClasses(skip?: number, limit?: number, sortOrder?: 'asc' | 'desc', sortBy?: 'name' | 'externalSourceName', options?: any): AxiosPromise<ClassInfoSearchListResponse> {
+            return localVarFp.groupControllerFindClasses(skip, limit, sortOrder, sortBy, options).then((request) => request(axios, basePath));
         },
         /**
          * 
@@ -9122,7 +9122,7 @@ export const GroupApiFactory = function (configuration?: Configuration, basePath
 export interface GroupApiInterface {
     /**
      * 
-     * @summary Get a list of classes and groups of type class for the current users school.
+     * @summary Get a list of classes and groups of type class for the current user.
      * @param {number} [skip] Number of elements (not pages) to be skipped
      * @param {number} [limit] Page limit, defaults to 10.
      * @param {'asc' | 'desc'} [sortOrder] 
@@ -9131,7 +9131,7 @@ export interface GroupApiInterface {
      * @throws {RequiredError}
      * @memberof GroupApiInterface
      */
-    groupControllerFindClassesForSchool(skip?: number, limit?: number, sortOrder?: 'asc' | 'desc', sortBy?: 'name' | 'externalSourceName', options?: any): AxiosPromise<ClassInfoSearchListResponse>;
+    groupControllerFindClasses(skip?: number, limit?: number, sortOrder?: 'asc' | 'desc', sortBy?: 'name' | 'externalSourceName', options?: any): AxiosPromise<ClassInfoSearchListResponse>;
 
     /**
      * 
@@ -9154,7 +9154,7 @@ export interface GroupApiInterface {
 export class GroupApi extends BaseAPI implements GroupApiInterface {
     /**
      * 
-     * @summary Get a list of classes and groups of type class for the current users school.
+     * @summary Get a list of classes and groups of type class for the current user.
      * @param {number} [skip] Number of elements (not pages) to be skipped
      * @param {number} [limit] Page limit, defaults to 10.
      * @param {'asc' | 'desc'} [sortOrder] 
@@ -9163,8 +9163,8 @@ export class GroupApi extends BaseAPI implements GroupApiInterface {
      * @throws {RequiredError}
      * @memberof GroupApi
      */
-    public groupControllerFindClassesForSchool(skip?: number, limit?: number, sortOrder?: 'asc' | 'desc', sortBy?: 'name' | 'externalSourceName', options?: any) {
-        return GroupApiFp(this.configuration).groupControllerFindClassesForSchool(skip, limit, sortOrder, sortBy, options).then((request) => request(this.axios, this.basePath));
+    public groupControllerFindClasses(skip?: number, limit?: number, sortOrder?: 'asc' | 'desc', sortBy?: 'name' | 'externalSourceName', options?: any) {
+        return GroupApiFp(this.configuration).groupControllerFindClasses(skip, limit, sortOrder, sortBy, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

src/store/group.ts

@@ -137,7 +137,7 @@ export default class GroupModule extends VuexModule {
 					: undefined;
 
 			const response: AxiosResponse<ClassInfoSearchListResponse> =
-				await this.groupApi.groupControllerFindClassesForSchool(
+				await this.groupApi.groupControllerFindClasses(
 					this.pagination.skip,
 					this.pagination.limit,
 					this.getSortOrder,

src/store/group.unit.ts

@@ -199,7 +199,7 @@ describe("GroupModule", () => {
 						limit: pagination.limit,
 					});
 
-				apiMock.groupControllerFindClassesForSchool.mockResolvedValue(
+				apiMock.groupControllerFindClasses.mockResolvedValue(
 					mockApiResponse({ data: response })
 				);
 
@@ -217,9 +217,7 @@ describe("GroupModule", () => {
 
 				await module.loadClassesForSchool();
 
-				expect(
-					apiMock.groupControllerFindClassesForSchool
-				).toHaveBeenCalledWith(
+				expect(apiMock.groupControllerFindClasses).toHaveBeenCalledWith(
 					pagination.skip,
 					pagination.limit,
 					sortOrder,
@@ -242,7 +240,7 @@ describe("GroupModule", () => {
 				const error = axiosErrorFactory.build();
 				const apiError = mapAxiosErrorToResponseError(error);
 
-				apiMock.groupControllerFindClassesForSchool.mockRejectedValue(error);
+				apiMock.groupControllerFindClasses.mockRejectedValue(error);
 
 				return {
 					apiError,
@@ -288,7 +286,7 @@ describe("GroupModule", () => {
 
 				await module.deleteClass(class1.id);
 
-				expect(apiMock.groupControllerFindClassesForSchool).toHaveBeenCalled();
+				expect(apiMock.groupControllerFindClasses).toHaveBeenCalled();
 			});
 		});