change endpoint

immich-app · Apr 25, 2024 · fbefa67 · fbefa67
1 parent 3f2e91d
commit fbefa67
Show file tree

Hide file tree

Showing 11 changed files with 76 additions and 78 deletions.
diff --git a/e2e/src/api/specs/asset.e2e-spec.ts b/e2e/src/api/specs/asset.e2e-spec.ts
@@ -852,7 +852,9 @@ describe('/asset', () => {
       expect(body).toEqual({ id: expect.any(String), duplicate: false });
       expect(status).toBe(201);
 
-      const { body: user } = await request(app).get('/user/me').set('Authorization', `Bearer ${quotaUser.accessToken}`);
+      const { body: user } = await request(app)
+        .get('/auth/user')
+        .set('Authorization', `Bearer ${quotaUser.accessToken}`);
 
       expect(user).toEqual(expect.objectContaining({ quotaUsageInBytes: 70 }));
     });

diff --git a/e2e/src/api/specs/user.e2e-spec.ts b/e2e/src/api/specs/user.e2e-spec.ts
@@ -42,9 +42,7 @@ describe('/user', () => {
     });
 
     it('should get users', async () => {
-      const { status, body } = await request(app)
-        .get('/user/admin')
-        .set('Authorization', `Bearer ${admin.accessToken}`);
+      const { status, body } = await request(app).get('/user').set('Authorization', `Bearer ${admin.accessToken}`);
       expect(status).toEqual(200);
       expect(body).toHaveLength(5);
       expect(body).toEqual(
@@ -77,7 +75,7 @@ describe('/user', () => {
 
     it('should include deleted users', async () => {
       const { status, body } = await request(app)
-        .get(`/user/admin`)
+        .get(`/user`)
         .query({ isAll: false })
         .set('Authorization', `Bearer ${admin.accessToken}`);
 
@@ -113,15 +111,15 @@ describe('/user', () => {
     });
   });
 
-  describe('GET /user/me', () => {
+  describe('GET /auth/user', () => {
     it('should require authentication', async () => {
-      const { status, body } = await request(app).get(`/user/me`);
+      const { status, body } = await request(app).get(`/auth/user`);
       expect(status).toBe(401);
       expect(body).toEqual(errorDto.unauthorized);
     });
 
     it('should get my info', async () => {
-      const { status, body } = await request(app).get(`/user/me`).set('Authorization', `Bearer ${admin.accessToken}`);
+      const { status, body } = await request(app).get(`/auth/user`).set('Authorization', `Bearer ${admin.accessToken}`);
       expect(status).toBe(200);
       expect(body).toMatchObject({
         id: admin.userId,
@@ -140,7 +138,7 @@ describe('/user', () => {
     for (const key of Object.keys(createUserDto.user1)) {
       it(`should not allow null ${key}`, async () => {
         const { status, body } = await request(app)
-          .post(`/user`)
+          .post(`/public-users`)
           .set('Authorization', `Bearer ${admin.accessToken}`)
           .send({ ...createUserDto.user1, [key]: null });
         expect(status).toBe(400);
@@ -223,15 +221,15 @@ describe('/user', () => {
 
   describe('PUT /user', () => {
     it('should require authentication', async () => {
-      const { status, body } = await request(app).put(`/user`);
+      const { status, body } = await request(app).put(`/public-users`);
       expect(status).toBe(401);
       expect(body).toEqual(errorDto.unauthorized);
     });
 
     for (const key of Object.keys(userDto.admin)) {
       it(`should not allow null ${key}`, async () => {
         const { status, body } = await request(app)
-          .put(`/user`)
+          .put(`/public-users`)
           .set('Authorization', `Bearer ${admin.accessToken}`)
           .send({ ...userDto.admin, [key]: null });
         expect(status).toBe(400);
@@ -241,7 +239,7 @@ describe('/user', () => {
 
     it('should not allow a non-admin to become an admin', async () => {
       const { status, body } = await request(app)
-        .put(`/user`)
+        .put(`/public-users`)
         .send({ isAdmin: true, id: nonAdmin.userId })
         .set('Authorization', `Bearer ${admin.accessToken}`);
 
@@ -251,7 +249,7 @@ describe('/user', () => {
 
     it('ignores updates to profileImagePath', async () => {
       const { status, body } = await request(app)
-        .put(`/user`)
+        .put(`/public-users`)
         .send({ id: admin.userId, profileImagePath: 'invalid.jpg' })
         .set('Authorization', `Bearer ${admin.accessToken}`);
 
@@ -263,7 +261,7 @@ describe('/user', () => {
       const before = await getUserById({ id: admin.userId }, { headers: asBearerAuth(admin.accessToken) });
 
       const { status, body } = await request(app)
-        .put(`/user`)
+        .put(`/public-users`)
         .send({
           id: admin.userId,
           createdAt: '2023-01-01T00:00:00.000Z',

diff --git a/mobile/openapi/README.md b/mobile/openapi/README.md
diff --git a/mobile/openapi/doc/AuthenticationApi.md b/mobile/openapi/doc/AuthenticationApi.md
diff --git a/mobile/openapi/doc/UserApi.md b/mobile/openapi/doc/UserApi.md
diff --git a/mobile/openapi/lib/api/authentication_api.dart b/mobile/openapi/lib/api/authentication_api.dart
diff --git a/mobile/openapi/lib/api/user_api.dart b/mobile/openapi/lib/api/user_api.dart
diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.json
@@ -2540,7 +2540,7 @@
         ]
       }
     },
-    "/auth/me": {
+    "/auth/user": {
       "get": {
         "operationId": "getMyUserInfo",
         "parameters": [],
@@ -6995,25 +6995,27 @@
       }
     },
     "/user": {
-      "post": {
-        "operationId": "createUser",
-        "parameters": [],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/CreateUserDto"
-              }
+      "get": {
+        "operationId": "getAllUsers",
+        "parameters": [
+          {
+            "name": "isAll",
+            "required": true,
+            "in": "query",
+            "schema": {
+              "type": "boolean"
             }
-          },
-          "required": true
-        },
+          }
+        ],
         "responses": {
-          "201": {
+          "200": {
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/UserResponseDto"
+                  "items": {
+                    "$ref": "#/components/schemas/UserResponseDto"
+                  },
+                  "type": "array"
                 }
               }
             },
@@ -7034,30 +7036,26 @@
         "tags": [
           "User"
         ]
-      }
-    },
-    "/user/admin": {
-      "get": {
-        "operationId": "getAllUsers",
-        "parameters": [
-          {
-            "name": "isAll",
-            "required": true,
-            "in": "query",
-            "schema": {
-              "type": "boolean"
+      },
+      "post": {
+        "operationId": "createUser",
+        "parameters": [],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateUserDto"
+              }
             }
-          }
-        ],
+          },
+          "required": true
+        },
         "responses": {
-          "200": {
+          "201": {
             "content": {
               "application/json": {
                 "schema": {
-                  "items": {
-                    "$ref": "#/components/schemas/UserResponseDto"
-                  },
-                  "type": "array"
+                  "$ref": "#/components/schemas/UserResponseDto"
                 }
               }
             },
@@ -7080,7 +7078,7 @@
         ]
       }
     },
-    "/user/admin/info/{id}": {
+    "/user/info/{id}": {
       "get": {
         "operationId": "getUserById",
         "parameters": [

diff --git a/open-api/typescript-sdk/src/fetch-client.ts b/open-api/typescript-sdk/src/fetch-client.ts
@@ -1722,7 +1722,7 @@ export function getMyUserInfo(opts?: Oazapfts.RequestOpts) {
     return oazapfts.ok(oazapfts.fetchJson<{
         status: 200;
         data: UserResponseDto;
-    }>("/auth/me", {
+    }>("/auth/user", {
         ...opts
     }));
 }
@@ -2878,6 +2878,18 @@ export function restoreAssets({ bulkIdsDto }: {
         body: bulkIdsDto
     })));
 }
+export function getAllUsers({ isAll }: {
+    isAll: boolean;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: UserResponseDto[];
+    }>(`/user${QS.query(QS.explode({
+        isAll
+    }))}`, {
+        ...opts
+    }));
+}
 export function createUser({ createUserDto }: {
     createUserDto: CreateUserDto;
 }, opts?: Oazapfts.RequestOpts) {
@@ -2890,25 +2902,13 @@ export function createUser({ createUserDto }: {
         body: createUserDto
     })));
 }
-export function getAllUsers({ isAll }: {
-    isAll: boolean;
-}, opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchJson<{
-        status: 200;
-        data: UserResponseDto[];
-    }>(`/user/admin${QS.query(QS.explode({
-        isAll
-    }))}`, {
-        ...opts
-    }));
-}
 export function getUserById({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts) {
     return oazapfts.ok(oazapfts.fetchJson<{
         status: 200;
         data: UserResponseDto;
-    }>(`/user/admin/info/${encodeURIComponent(id)}`, {
+    }>(`/user/info/${encodeURIComponent(id)}`, {
         ...opts
     }));
 }

diff --git a/server/src/controllers/auth.controller.ts b/server/src/controllers/auth.controller.ts
@@ -80,7 +80,7 @@ export class AuthController {
     ]);
   }
 
-  @Get('me')
+  @Get('user')
   getMyUserInfo(@Auth() auth: AuthDto): Promise<UserResponseDto> {
     return this.userService.getMe(auth);
   }

diff --git a/server/src/controllers/user.controller.ts b/server/src/controllers/user.controller.ts
@@ -13,12 +13,12 @@ import { UUIDParamDto } from 'src/validation';
 export class UserController {
   constructor(private service: UserService) {}
 
-  @Get('admin')
+  @Get()
   getAllUsers(@Query('isAll') isAll: boolean): Promise<UserResponseDto[]> {
     return this.service.getAll(isAll);
   }
 
-  @Get('admin/info/:id')
+  @Get('info/:id')
   getUserById(@Param() { id }: UUIDParamDto): Promise<UserResponseDto> {
     return this.service.get(id);
   }