fix member typing (#336)

* fix member typing

* adjust the test so it can pass

Author: longshuicy

backend/app/models/groups.py

@@ -1,23 +1,21 @@
 from datetime import datetime
-from typing import Optional
+from typing import Optional, List
 
-from mongoengine import DynamicDocument
 from pydantic import Field, BaseModel
-from pydantic import Field
 
 from app.models.mongomodel import OID, MongoModel
 from app.models.users import UserOut
 
 
-class Member:
+class Member(BaseModel):
     user: UserOut
     isOwner: bool = False
 
 
 class GroupBase(BaseModel):
     name: str = "N/A"
     description: str = "N/A"
-    userList = [Member()]
+    userList: List[Member] = []
 
 
 class GroupIn(GroupBase):

backend/app/routers/groups.py

@@ -7,8 +7,7 @@
 from pymongo.mongo_client import MongoClient
 
 from app import keycloak_auth, dependencies
-from app.keycloak_auth import get_current_user
-from app.models.groups import GroupOut, GroupIn, GroupDB, Member, GroupBase
+from app.models.groups import GroupOut, GroupIn, GroupDB, GroupBase
 from app.models.users import UserOut
 from app.routers.users import get_user
 

backend/app/tests/test_groups.py

@@ -77,7 +77,9 @@ def test_add_and_remove_member(client: TestClient, headers: dict):
 
     # removing member
     new_group = response.json()
-    new_group["userList"].remove(member2)
+    new_group["userList"].pop()
+
+    # TODO add a put endpoint for this
     response = client.post(
         f"{settings.API_V2_STR}/groups", headers=headers, json=new_group
     )

frontend/src/openapi/v2/index.ts

@@ -28,8 +28,12 @@ export type { FileOut } from './models/FileOut';
 export type { FileVersion } from './models/FileVersion';
 export type { FolderIn } from './models/FolderIn';
 export type { FolderOut } from './models/FolderOut';
+export type { GroupBase } from './models/GroupBase';
+export type { GroupIn } from './models/GroupIn';
+export type { GroupOut } from './models/GroupOut';
 export type { HTTPValidationError } from './models/HTTPValidationError';
 export type { LegacyEventListenerIn } from './models/LegacyEventListenerIn';
+export type { Member } from './models/Member';
 export type { MetadataAgent } from './models/MetadataAgent';
 export type { MetadataConfig } from './models/MetadataConfig';
 export type { MetadataDefinitionIn } from './models/MetadataDefinitionIn';
@@ -58,6 +62,7 @@ export { ExtractorsService } from './services/ExtractorsService';
 export { FeedsService } from './services/FeedsService';
 export { FilesService } from './services/FilesService';
 export { FoldersService } from './services/FoldersService';
+export { GroupsService } from './services/GroupsService';
 export { JobsService } from './services/JobsService';
 export { ListenersService } from './services/ListenersService';
 export { LoginService } from './services/LoginService';

frontend/src/openapi/v2/models/GroupBase.ts

@@ -0,0 +1,11 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Member } from './Member';
+
+export type GroupBase = {
+    name?: string;
+    description?: string;
+    userList?: Array<Member>;
+}

frontend/src/openapi/v2/models/GroupIn.ts

@@ -0,0 +1,11 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Member } from './Member';
+
+export type GroupIn = {
+    name?: string;
+    description?: string;
+    userList?: Array<Member>;
+}

frontend/src/openapi/v2/models/GroupOut.ts

@@ -0,0 +1,17 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Member } from './Member';
+import type { UserOut } from './UserOut';
+
+export type GroupOut = {
+    name?: string;
+    description?: string;
+    userList?: Array<Member>;
+    id?: string;
+    author: UserOut;
+    created?: string;
+    modified?: string;
+    views?: number;
+}

frontend/src/openapi/v2/models/Member.ts

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { UserOut } from './UserOut';
+
+export type Member = {
+    user: UserOut;
+    isOwner?: boolean;
+}

frontend/src/openapi/v2/services/GroupsService.ts

@@ -0,0 +1,113 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { GroupBase } from '../models/GroupBase';
+import type { GroupIn } from '../models/GroupIn';
+import type { GroupOut } from '../models/GroupOut';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { request as __request } from '../core/request';
+
+export class GroupsService {
+
+    /**
+     * Save Group
+     * @param requestBody
+     * @returns GroupOut Successful Response
+     * @throws ApiError
+     */
+    public static saveGroupApiV2GroupsPost(
+        requestBody: GroupIn,
+    ): CancelablePromise<GroupOut> {
+        return __request({
+            method: 'POST',
+            path: `/api/v2/groups`,
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                422: `Validation Error`,
+            },
+        });
+    }
+
+    /**
+     * Get Group
+     * @param groupId
+     * @returns GroupOut Successful Response
+     * @throws ApiError
+     */
+    public static getGroupApiV2GroupsGroupIdGet(
+        groupId: string,
+    ): CancelablePromise<GroupOut> {
+        return __request({
+            method: 'GET',
+            path: `/api/v2/groups/${groupId}`,
+            errors: {
+                422: `Validation Error`,
+            },
+        });
+    }
+
+    /**
+     * Edit Group
+     * @param groupId
+     * @param userId
+     * @param requestBody
+     * @returns GroupOut Successful Response
+     * @throws ApiError
+     */
+    public static editGroupApiV2GroupsGroupIdPost(
+        groupId: string,
+        userId: string,
+        requestBody: GroupBase,
+    ): CancelablePromise<GroupOut> {
+        return __request({
+            method: 'POST',
+            path: `/api/v2/groups/${groupId}`,
+            query: {
+                'user_id': userId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                422: `Validation Error`,
+            },
+        });
+    }
+
+    /**
+     * Delete Group
+     * @param groupId
+     * @returns any Successful Response
+     * @throws ApiError
+     */
+    public static deleteGroupApiV2GroupsGroupIdDelete(
+        groupId: string,
+    ): CancelablePromise<any> {
+        return __request({
+            method: 'DELETE',
+            path: `/api/v2/groups/${groupId}`,
+            errors: {
+                422: `Validation Error`,
+            },
+        });
+    }
+
+    /**
+     * Search Group
+     * @param searchTerm
+     * @returns any Successful Response
+     * @throws ApiError
+     */
+    public static searchGroupApiV2GroupsSearchSearchTermGet(
+        searchTerm: string,
+    ): CancelablePromise<any> {
+        return __request({
+            method: 'GET',
+            path: `/api/v2/groups/search/${searchTerm}`,
+            errors: {
+                422: `Validation Error`,
+            },
+        });
+    }
+
+}