fix: validate OpenAPI spec (#1528)

* init api check test * Fix openAPI issues Co-authored-by: Hayden <[email protected]>
mealie-recipes · Aug 7, 2022 · 34cd6eb · 34cd6eb
1 parent 505e594
commit 34cd6eb
Show file tree

Hide file tree

Showing 8 changed files with 113 additions and 12 deletions.
diff --git a/frontend/api/class-interfaces/users.ts b/frontend/api/class-interfaces/users.ts
@@ -16,12 +16,12 @@ const prefix = "/api";
 const routes = {
   usersSelf: `${prefix}/users/self`,
   passwordReset: `${prefix}/users/reset-password`,
+  passwordChange: `${prefix}/users/password`,
   users: `${prefix}/users`,
 
   usersIdImage: (id: string) => `${prefix}/users/${id}/image`,
   usersIdResetPassword: (id: string) => `${prefix}/users/${id}/reset-password`,
   usersId: (id: string) => `${prefix}/users/${id}`,
-  usersIdPassword: (id: string) => `${prefix}/users/${id}/password`,
   usersIdFavorites: (id: string) => `${prefix}/users/${id}/favorites`,
   usersIdFavoritesSlug: (id: string, slug: string) => `${prefix}/users/${id}/favorites/${slug}`,
 
@@ -45,8 +45,8 @@ export class UserApi extends BaseCRUDAPI<UserIn, UserOut, UserBase> {
     return await this.requests.get<UserFavorites>(routes.usersIdFavorites(id));
   }
 
-  async changePassword(id: string, changePassword: ChangePassword) {
-    return await this.requests.put(routes.usersIdPassword(id), changePassword);
+  async changePassword(changePassword: ChangePassword) {
+    return await this.requests.put(routes.passwordChange, changePassword);
   }
 
   async createAPIToken(tokenName: LongLiveTokenIn) {

diff --git a/frontend/pages/user/profile/edit.vue b/frontend/pages/user/profile/edit.vue
@@ -161,7 +161,7 @@ export default defineComponent({
       if (!userCopy.value?.id) {
         return;
       }
-      const { response } = await api.users.changePassword(userCopy.value.id, {
+      const { response } = await api.users.changePassword({
         currentPassword: password.current,
         newPassword: password.newOne,
       });

diff --git a/mealie/routes/recipe/__init__.py b/mealie/routes/recipe/__init__.py
@@ -10,6 +10,5 @@
 router.include_router(recipe_crud_routes.router_exports)
 router.include_router(recipe_crud_routes.router)
 router.include_router(comments.router, prefix=prefix, tags=["Recipe: Comments"])
-router.include_router(bulk_actions.router, prefix=prefix)
 router.include_router(bulk_actions.router, prefix=prefix, tags=["Recipe: Bulk Exports"])
 router.include_router(shared_routes.router, prefix=prefix, tags=["Recipe: Shared"])
diff --git a/mealie/routes/users/crud.py b/mealie/routes/users/crud.py
@@ -85,7 +85,7 @@ def update_user(self, item_id: UUID4, new_data: UserBase):
 
         return SuccessResponse.respond("User updated")
 
-    @user_router.put("/{item_id}/password")
+    @user_router.put("/password")
     def update_password(self, password_change: ChangePassword):
         """Resets the User Password"""
         if not verify_password(password_change.current_password, self.user.password):

diff --git a/mealie/schema/user/user.py b/mealie/schema/user/user.py
@@ -82,11 +82,13 @@ def getter_dict(cls, name_orm: User):
             }
 
         schema_extra = {
-            "username": "ChangeMe",
-            "fullName": "Change Me",
-            "email": "[email protected]",
-            "group": settings.DEFAULT_GROUP,
-            "admin": "false",
+            "example": {
+                "username": "ChangeMe",
+                "fullName": "Change Me",
+                "email": "[email protected]",
+                "group": settings.DEFAULT_GROUP,
+                "admin": "false",
+            }
         }
 
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -59,6 +59,7 @@ types-requests = "^2.27.12"
 types-urllib3 = "^1.26.11"
 pre-commit = "^2.17.0"
 types-python-dateutil = "^2.8.18"
+openapi-spec-validator = "^0.4.0"
 
 
 [build-system]

diff --git a/tests/unit_tests/test_open_api.py b/tests/unit_tests/test_open_api.py
@@ -0,0 +1,8 @@
+from openapi_spec_validator import validate_v3_spec
+
+from mealie.app import app
+
+
+def test_validate_open_api_spec():
+    open_api = app.openapi()
+    validate_v3_spec(open_api)