add: backup version converter/ backup logic 1.0

api/setting/markdown/permission.py

@@ -10,6 +10,21 @@ from db.models.MarkdownPermissionSetting import MarkdownPermissionSetting
 @etag_response
 @limiter.limit(api.get_rate_limit)
 def get_permission_setting(setting_id):
+    """
+    Get a specific markdown permission setting by ID.
+
+    This endpoint retrieves a markdown permission setting by its ID.
+
+    Request:
+        - setting_id (int): The ID of the permission setting to retrieve
+
+    Returns:
+        A JSON object containing the permission setting.
+
+    Response Codes:
+        - 200: Success
+        - 204: No content (setting not found)
+    """
     with get_db() as session:
         setting = session.query(MarkdownPermissionSetting).get(setting_id)
         if not setting:
@@ -20,6 +35,21 @@ def get_permission_setting(setting_id):
 @setting_bp.route('/markdown/permission/', methods=['POST'])
 @require_auth(roles=['admin'])
 def create_permission_setting():
+    """
+    Create a new markdown permission setting.
+
+    This endpoint creates a new markdown permission setting with the provided permission value.
+    It requires authentication with the 'admin' role.
+
+    Request:
+        - permission (str): The permission value (e.g., 'private', 'protected', etc.)
+
+    Returns:
+        A JSON object containing the created permission setting.
+
+    Response Codes:
+        - 201: Created successfully
+    """
     data = request.json
     permission = data.get('permission')
     new_setting = MarkdownPermissionSetting(permission=permission)
@@ -32,6 +62,26 @@ def create_permission_setting():
 @setting_bp.route('/markdown/permission/<int:setting_id>', methods=['PUT', 'PATCH'])
 @require_auth(roles=['admin'])
 def update_permission_setting(setting_id):
+    """
+    Update a markdown permission setting.
+
+    This endpoint updates an existing markdown permission setting with the provided permission value.
+    It requires authentication with the 'admin' role.
+
+    - PUT: Replaces the entire permission setting
+    - PATCH: Updates only the specified fields
+
+    Request:
+        - setting_id (int): The ID of the permission setting to update
+        - permission (str): The new permission value
+
+    Returns:
+        A JSON object containing the updated permission setting.
+
+    Response Codes:
+        - 200: Updated successfully
+        - 404: Permission setting not found
+    """
     with get_db() as session:
         setting = session.get(MarkdownPermissionSetting, setting_id)
         if setting is None:
@@ -48,6 +98,21 @@ def update_permission_setting(setting_id):
 @setting_bp.route('/markdown/permission/<int:setting_id>', methods=['DELETE'])
 @require_auth(roles=['admin'])
 def delete_permission_setting(setting_id):
+    """
+    Delete a markdown permission setting.
+
+    This endpoint deletes an existing markdown permission setting.
+    It requires authentication with the 'admin' role.
+
+    Request:
+        - setting_id (int): The ID of the permission setting to delete
+
+    Returns:
+        A JSON object containing the deleted permission setting.
+
+    Response Codes:
+        - 200: Deleted successfully
+    """
     with get_db() as session:
         setting = session.get(MarkdownPermissionSetting, setting_id)
         st = setting.to_dict()